From 116c0e65389b487d4ce935f8d0ee25bbc8add723 Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Tue, 3 Mar 2026 16:18:15 +0100 Subject: [PATCH 1/8] sdk docs v0 Signed-off-by: Jan Jeliga --- apps/agentstack-sdk-py/docs/generate_docs.py | 628 +++++++++++++++ .../docs/introspect_exports.py | 760 ++++++++++++++++++ .../docs/templates/class.mdx.j2 | 99 +++ .../docs/templates/function.mdx.j2 | 40 + .../docs/templates/module.mdx.j2 | 90 +++ .../docs/templates/overview.mdx.j2 | 25 + apps/agentstack-sdk-py/pyproject.toml | 3 + .../src/agentstack_sdk/platform/client.py | 3 + apps/agentstack-sdk-py/tasks.toml | 68 ++ apps/agentstack-sdk-py/uv.lock | 83 ++ .../python-sdk/a2a-auth-oauth-storage.mdx | 26 + .../MemoryTokenStorage.mdx | 59 ++ .../MemoryTokenStorageFactory.mdx | 34 + .../TokenStorageFactory.mdx | 27 + .../reference/python-sdk/a2a-auth-oauth.mdx | 43 + .../python-sdk/a2a-auth-oauth/AuthRequest.mdx | 22 + .../a2a-auth-oauth/AuthResponse.mdx | 22 + .../python-sdk/a2a-auth-oauth/OAuthDemand.mdx | 22 + .../a2a-auth-oauth/OAuthExtensionClient.mdx | 48 ++ .../a2a-auth-oauth/OAuthExtensionMetadata.mdx | 22 + .../a2a-auth-oauth/OAuthExtensionParams.mdx | 22 + .../a2a-auth-oauth/OAuthExtensionServer.mdx | 71 ++ .../a2a-auth-oauth/OAuthExtensionSpec.mdx | 39 + .../a2a-auth-oauth/OAuthFulfillment.mdx | 22 + .../reference/python-sdk/a2a-auth-secrets.mdx | 40 + .../a2a-auth-secrets/SecretDemand.mdx | 23 + .../a2a-auth-secrets/SecretFulfillment.mdx | 22 + .../SecretsExtensionClient.mdx | 17 + .../SecretsExtensionServer.mdx | 58 ++ .../a2a-auth-secrets/SecretsExtensionSpec.mdx | 41 + .../SecretsServiceExtensionMetadata.mdx | 22 + .../SecretsServiceExtensionParams.mdx | 22 + .../reference/python-sdk/a2a-auth.mdx | 20 + .../reference/python-sdk/a2a-common.mdx | 78 ++ .../python-sdk/a2a-common/BaseField.mdx | 25 + .../python-sdk/a2a-common/BaseFormRender.mdx | 26 + .../a2a-common/BaseFormResponse.mdx | 22 + .../python-sdk/a2a-common/CheckboxField.mdx | 24 + .../a2a-common/CheckboxFieldValue.mdx | 23 + .../a2a-common/CheckboxGroupField.mdx | 23 + .../a2a-common/CheckboxGroupFieldValue.mdx | 23 + .../python-sdk/a2a-common/DateField.mdx | 24 + .../python-sdk/a2a-common/DateFieldValue.mdx | 23 + .../python-sdk/a2a-common/FileField.mdx | 23 + .../python-sdk/a2a-common/FileFieldValue.mdx | 23 + .../python-sdk/a2a-common/FileInfo.mdx | 24 + .../python-sdk/a2a-common/FileItem.mdx | 24 + .../python-sdk/a2a-common/FormRender.mdx | 17 + .../python-sdk/a2a-common/FormResponse.mdx | 17 + .../a2a-common/MultiSelectField.mdx | 32 + .../a2a-common/MultiSelectFieldValue.mdx | 23 + .../python-sdk/a2a-common/OptionItem.mdx | 23 + .../a2a-common/SettingsFormRender.mdx | 17 + .../a2a-common/SettingsFormResponse.mdx | 17 + .../a2a-common/SingleSelectField.mdx | 32 + .../a2a-common/SingleSelectFieldValue.mdx | 23 + .../python-sdk/a2a-common/TextField.mdx | 25 + .../python-sdk/a2a-common/TextFieldValue.mdx | 23 + .../BaseExtensionClient.mdx | 50 ++ .../BaseExtensionServer.mdx | 67 ++ .../a2a-extensions-base/BaseExtensionSpec.mdx | 69 ++ .../NoParamsBaseExtensionSpec.mdx | 34 + .../ExtensionError.mdx | 37 + .../reference/python-sdk/a2a-interactions.mdx | 47 ++ .../ApprovalExtensionClient.mdx | 42 + .../ApprovalExtensionMetadata.mdx | 17 + .../ApprovalExtensionParams.mdx | 17 + .../ApprovalExtensionServer.mdx | 48 ++ .../ApprovalExtensionSpec.mdx | 22 + .../ApprovalRejectionError.mdx | 17 + .../a2a-interactions/ApprovalResponse.mdx | 34 + .../GenericApprovalRequest.mdx | 24 + .../ToolCallApprovalRequest.mdx | 46 ++ .../a2a-interactions/ToolCallServer.mdx | 24 + .../reference/python-sdk/a2a-services.mdx | 95 +++ .../a2a-services/EmbeddingDemand.mdx | 23 + .../a2a-services/EmbeddingFulfillment.mdx | 25 + .../EmbeddingServiceExtensionClient.mdx | 33 + .../EmbeddingServiceExtensionMetadata.mdx | 22 + .../EmbeddingServiceExtensionParams.mdx | 22 + .../EmbeddingServiceExtensionServer.mdx | 32 + .../EmbeddingServiceExtensionSpec.mdx | 41 + .../python-sdk/a2a-services/FormDemands.mdx | 23 + .../FormServiceExtensionClient.mdx | 33 + .../FormServiceExtensionMetadata.mdx | 22 + .../FormServiceExtensionParams.mdx | 22 + .../FormServiceExtensionServer.mdx | 48 ++ .../a2a-services/FormServiceExtensionSpec.mdx | 65 ++ .../python-sdk/a2a-services/LLMDemand.mdx | 23 + .../a2a-services/LLMFulfillment.mdx | 25 + .../LLMServiceExtensionClient.mdx | 33 + .../LLMServiceExtensionMetadata.mdx | 22 + .../LLMServiceExtensionParams.mdx | 22 + .../LLMServiceExtensionServer.mdx | 32 + .../a2a-services/LLMServiceExtensionSpec.mdx | 41 + .../python-sdk/a2a-services/MCPDemand.mdx | 24 + .../a2a-services/MCPFulfillment.mdx | 22 + .../MCPServiceExtensionClient.mdx | 33 + .../MCPServiceExtensionMetadata.mdx | 22 + .../MCPServiceExtensionParams.mdx | 22 + .../MCPServiceExtensionServer.mdx | 49 ++ .../a2a-services/MCPServiceExtensionSpec.mdx | 42 + .../a2a-services/PlatformApiExtension.mdx | 17 + .../PlatformApiExtensionClient.mdx | 35 + .../PlatformApiExtensionMetadata.mdx | 24 + .../PlatformApiExtensionParams.mdx | 22 + .../PlatformApiExtensionServer.mdx | 51 ++ .../a2a-services/PlatformApiExtensionSpec.mdx | 39 + .../a2a-services/StdioTransport.mdx | 25 + .../a2a-services/StreamableHTTPTransport.mdx | 24 + .../reference/python-sdk/a2a-tools.mdx | 38 + .../a2a-tools/ToolCallExtensionClient.mdx | 42 + .../a2a-tools/ToolCallExtensionMetadata.mdx | 17 + .../a2a-tools/ToolCallExtensionParams.mdx | 17 + .../a2a-tools/ToolCallExtensionServer.mdx | 48 ++ .../a2a-tools/ToolCallExtensionSpec.mdx | 22 + .../a2a-tools/ToolCallRejectionError.mdx | 17 + .../python-sdk/a2a-tools/ToolCallRequest.mdx | 45 ++ .../python-sdk/a2a-tools/ToolCallResponse.mdx | 22 + .../python-sdk/a2a-tools/ToolCallServer.mdx | 24 + .../python-sdk/a2a-types/AgentArtifact.mdx | 31 + .../python-sdk/a2a-types/AgentMessage.mdx | 33 + .../python-sdk/a2a-types/ArtifactChunk.mdx | 31 + .../python-sdk/a2a-types/AuthRequired.mdx | 22 + .../python-sdk/a2a-types/InputRequired.mdx | 33 + .../python-sdk/a2a-types/Metadata.mdx | 17 + .../reference/python-sdk/a2a-ui.mdx | 112 +++ .../python-sdk/a2a-ui/AgentDetail.mdx | 34 + .../a2a-ui/AgentDetailContributor.mdx | 24 + .../a2a-ui/AgentDetailExtensionClient.mdx | 17 + .../a2a-ui/AgentDetailExtensionServer.mdx | 17 + .../a2a-ui/AgentDetailExtensionSpec.mdx | 22 + .../python-sdk/a2a-ui/AgentDetailTool.mdx | 23 + .../python-sdk/a2a-ui/AgentRunSettings.mdx | 22 + .../python-sdk/a2a-ui/CanvasEditRequest.mdx | 25 + .../a2a-ui/CanvasEditRequestMetadata.mdx | 25 + .../a2a-ui/CanvasExtensionServer.mdx | 42 + .../python-sdk/a2a-ui/CanvasExtensionSpec.mdx | 22 + .../python-sdk/a2a-ui/CheckboxField.mdx | 24 + .../python-sdk/a2a-ui/CheckboxFieldValue.mdx | 22 + .../python-sdk/a2a-ui/CheckboxGroupField.mdx | 24 + .../a2a-ui/CheckboxGroupFieldValue.mdx | 23 + .../reference/python-sdk/a2a-ui/Citation.mdx | 47 ++ .../a2a-ui/CitationExtensionClient.mdx | 17 + .../a2a-ui/CitationExtensionServer.mdx | 45 ++ .../a2a-ui/CitationExtensionSpec.mdx | 22 + .../python-sdk/a2a-ui/CitationMetadata.mdx | 22 + .../reference/python-sdk/a2a-ui/EnvVar.mdx | 24 + .../reference/python-sdk/a2a-ui/Error.mdx | 32 + .../python-sdk/a2a-ui/ErrorContext.mdx | 23 + .../a2a-ui/ErrorExtensionClient.mdx | 17 + .../a2a-ui/ErrorExtensionParams.mdx | 24 + .../a2a-ui/ErrorExtensionServer.mdx | 79 ++ .../python-sdk/a2a-ui/ErrorExtensionSpec.mdx | 22 + .../python-sdk/a2a-ui/ErrorGroup.mdx | 26 + .../python-sdk/a2a-ui/ErrorMetadata.mdx | 28 + .../a2a-ui/FormRequestExtensionClient.mdx | 17 + .../a2a-ui/FormRequestExtensionServer.mdx | 54 ++ .../a2a-ui/FormRequestExtensionSpec.mdx | 22 + .../python-sdk/a2a-ui/OptionItem.mdx | 23 + .../a2a-ui/SettingsExtensionClient.mdx | 17 + .../a2a-ui/SettingsExtensionServer.mdx | 27 + .../a2a-ui/SettingsExtensionSpec.mdx | 22 + .../python-sdk/a2a-ui/SettingsRender.mdx | 22 + .../python-sdk/a2a-ui/SingleSelectField.mdx | 26 + .../a2a-ui/SingleSelectFieldValue.mdx | 23 + .../python-sdk/a2a-ui/Trajectory.mdx | 39 + .../a2a-ui/TrajectoryExtensionClient.mdx | 17 + .../a2a-ui/TrajectoryExtensionServer.mdx | 48 ++ .../a2a-ui/TrajectoryExtensionSpec.mdx | 22 + docs/development/reference/python-sdk/a2a.mdx | 32 + .../reference/python-sdk/overview.mdx | 35 + .../reference/python-sdk/platform.mdx | 244 ++++++ .../python-sdk/platform/AddProvider.mdx | 25 + .../platform/AuthorizationCodeRequest.mdx | 23 + .../platform/BuildConfiguration.mdx | 22 + .../python-sdk/platform/BuildState.mdx | 26 + .../platform/ChangeRoleResponse.mdx | 23 + .../python-sdk/platform/Connector.mdx | 234 ++++++ .../python-sdk/platform/ConnectorPreset.mdx | 23 + .../python-sdk/platform/ConnectorState.mdx | 25 + .../reference/python-sdk/platform/Context.mdx | 171 ++++ .../platform/ContextHistoryItem.mdx | 26 + .../platform/ContextPermissions.mdx | 24 + .../python-sdk/platform/ContextToken.mdx | 24 + .../python-sdk/platform/DiscoveryState.mdx | 25 + .../reference/python-sdk/platform/EnvVar.mdx | 24 + .../python-sdk/platform/ExtractedFileInfo.mdx | 23 + .../python-sdk/platform/Extraction.mdx | 31 + .../reference/python-sdk/platform/File.mdx | 164 ++++ .../python-sdk/platform/GithubVersionType.mdx | 23 + .../platform/ListUserFeedbackResponse.mdx | 17 + .../python-sdk/platform/MCPProxyResponse.mdx | 24 + .../python-sdk/platform/ModelCapability.mdx | 23 + .../python-sdk/platform/ModelProvider.mdx | 97 +++ .../platform/ModelProviderState.mdx | 23 + .../python-sdk/platform/ModelProviderType.mdx | 42 + .../python-sdk/platform/ModelWithScore.mdx | 23 + .../python-sdk/platform/NoAction.mdx | 22 + .../python-sdk/platform/PaginatedResult.mdx | 25 + .../python-sdk/platform/Permissions.mdx | 30 + .../python-sdk/platform/PlatformClient.mdx | 59 ++ .../python-sdk/platform/Provider.mdx | 166 ++++ .../python-sdk/platform/ProviderBuild.mdx | 108 +++ .../python-sdk/platform/ProviderDiscovery.mdx | 56 ++ .../platform/ProviderErrorMessage.mdx | 22 + .../platform/ResolvedDockerImageID.mdx | 25 + .../python-sdk/platform/ResolvedGithubUrl.mdx | 28 + .../platform/SystemConfiguration.mdx | 57 ++ .../python-sdk/platform/UpdateProvider.mdx | 23 + .../reference/python-sdk/platform/User.mdx | 67 ++ .../python-sdk/platform/UserFeedback.mdx | 51 ++ .../python-sdk/platform/UserRole.mdx | 24 + .../python-sdk/platform/Variables.mdx | 51 ++ .../python-sdk/platform/VectorStore.mdx | 120 +++ .../platform/VectorStoreDocument.mdx | 26 + .../python-sdk/platform/VectorStoreItem.mdx | 40 + .../platform/VectorStoreSearchResult.mdx | 23 + .../python-sdk/platform/VectorStoreStats.mdx | 23 + .../python-sdk/platform/VersionInfo.mdx | 23 + .../platform/get_platform_client.mdx | 16 + .../platform/set_platform_client.mdx | 16 + .../platform/use_platform_client.mdx | 16 + .../python-sdk/platform/uuid_to_str.mdx | 25 + .../python-sdk/platform/validate_metadata.mdx | 24 + .../reference/python-sdk/server.mdx | 22 + .../reference/python-sdk/server/Agent.mdx | 51 ++ .../python-sdk/server/AgentExecuteFn.mdx | 17 + .../reference/python-sdk/server/AgentRun.mdx | 69 ++ .../python-sdk/server/ContextStore.mdx | 44 + .../server/ContextStoreInstance.mdx | 53 ++ .../reference/python-sdk/server/Depends.mdx | 35 + .../reference/python-sdk/server/Executor.mdx | 59 ++ .../server/InMemoryContextStore.mdx | 47 ++ .../server/MemoryContextStoreInstance.mdx | 66 ++ .../python-sdk/server/PlatformAuthBackend.mdx | 61 ++ .../server/PlatformAuthenticatedUser.mdx | 42 + .../server/PlatformContextStore.mdx | 44 + .../server/PlatformContextStoreInstance.mdx | 61 ++ .../python-sdk/server/RunContext.mdx | 84 ++ .../reference/python-sdk/server/Server.mdx | 127 +++ .../python-sdk/server/cancel_task.mdx | 21 + .../python-sdk/server/close_queue.mdx | 26 + .../python-sdk/server/configure_telemetry.mdx | 25 + .../python-sdk/server/create_app.mdx | 24 + .../python-sdk/server/discover_jwks.mdx | 21 + .../server/extract_dependencies.mdx | 24 + .../reference/python-sdk/types.mdx | 28 + .../types/SdkAuthenticationBackend.mdx | 33 + .../development/reference/python-sdk/util.mdx | 22 + .../reference/python-sdk/util/BearerAuth.mdx | 50 ++ .../python-sdk/util/ColoredFormatter.mdx | 36 + .../reference/python-sdk/util/LoadedFile.mdx | 100 +++ .../python-sdk/util/LoadedFileWithBytes.mdx | 99 +++ .../python-sdk/util/LoadedFileWithUri.mdx | 110 +++ .../python-sdk/util/PlatformFileUrl.mdx | 22 + .../python-sdk/util/SecureBaseModel.mdx | 18 + .../apply_compatibility_monkey_patching.mdx | 18 + .../python-sdk/util/configure_logger.mdx | 24 + .../python-sdk/util/extract_messages.mdx | 24 + .../reference/python-sdk/util/filter_dict.mdx | 20 + .../python-sdk/util/flatten_dict.mdx | 28 + .../reference/python-sdk/util/load_file.mdx | 27 + .../python-sdk/util/parse_stream.mdx | 25 + .../reference/python-sdk/util/redact_dict.mdx | 24 + .../python-sdk/util/redact_secret.mdx | 24 + .../reference/python-sdk/util/redact_str.mdx | 24 + .../reference/python-sdk/util/redact_url.mdx | 24 + .../python-sdk/util/resource_context.mdx | 24 + .../python-sdk/util/should_redact.mdx | 24 + .../python-sdk/util/should_reveal.mdx | 24 + .../reference/python-sdk/util/trace_class.mdx | 72 ++ .../python-sdk/util/trace_function.mdx | 66 ++ .../reference/python-sdk/util/utc_now.mdx | 20 + docs/docs.json | 43 +- 275 files changed, 11407 insertions(+), 2 deletions(-) create mode 100644 apps/agentstack-sdk-py/docs/generate_docs.py create mode 100644 apps/agentstack-sdk-py/docs/introspect_exports.py create mode 100644 apps/agentstack-sdk-py/docs/templates/class.mdx.j2 create mode 100644 apps/agentstack-sdk-py/docs/templates/function.mdx.j2 create mode 100644 apps/agentstack-sdk-py/docs/templates/module.mdx.j2 create mode 100644 apps/agentstack-sdk-py/docs/templates/overview.mdx.j2 create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-auth.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/BaseField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/DateField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/FileField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/FileInfo.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/FileItem.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/FormRender.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/FormResponse.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/OptionItem.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/TextField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx create mode 100644 docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/FormDemands.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx create mode 100644 docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx create mode 100644 docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx create mode 100644 docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx create mode 100644 docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx create mode 100644 docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx create mode 100644 docs/development/reference/python-sdk/a2a-types/InputRequired.mdx create mode 100644 docs/development/reference/python-sdk/a2a-types/Metadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/Citation.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/Error.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx create mode 100644 docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx create mode 100644 docs/development/reference/python-sdk/a2a.mdx create mode 100644 docs/development/reference/python-sdk/overview.mdx create mode 100644 docs/development/reference/python-sdk/platform.mdx create mode 100644 docs/development/reference/python-sdk/platform/AddProvider.mdx create mode 100644 docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx create mode 100644 docs/development/reference/python-sdk/platform/BuildConfiguration.mdx create mode 100644 docs/development/reference/python-sdk/platform/BuildState.mdx create mode 100644 docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx create mode 100644 docs/development/reference/python-sdk/platform/Connector.mdx create mode 100644 docs/development/reference/python-sdk/platform/ConnectorPreset.mdx create mode 100644 docs/development/reference/python-sdk/platform/ConnectorState.mdx create mode 100644 docs/development/reference/python-sdk/platform/Context.mdx create mode 100644 docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx create mode 100644 docs/development/reference/python-sdk/platform/ContextPermissions.mdx create mode 100644 docs/development/reference/python-sdk/platform/ContextToken.mdx create mode 100644 docs/development/reference/python-sdk/platform/DiscoveryState.mdx create mode 100644 docs/development/reference/python-sdk/platform/EnvVar.mdx create mode 100644 docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx create mode 100644 docs/development/reference/python-sdk/platform/Extraction.mdx create mode 100644 docs/development/reference/python-sdk/platform/File.mdx create mode 100644 docs/development/reference/python-sdk/platform/GithubVersionType.mdx create mode 100644 docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx create mode 100644 docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx create mode 100644 docs/development/reference/python-sdk/platform/ModelCapability.mdx create mode 100644 docs/development/reference/python-sdk/platform/ModelProvider.mdx create mode 100644 docs/development/reference/python-sdk/platform/ModelProviderState.mdx create mode 100644 docs/development/reference/python-sdk/platform/ModelProviderType.mdx create mode 100644 docs/development/reference/python-sdk/platform/ModelWithScore.mdx create mode 100644 docs/development/reference/python-sdk/platform/NoAction.mdx create mode 100644 docs/development/reference/python-sdk/platform/PaginatedResult.mdx create mode 100644 docs/development/reference/python-sdk/platform/Permissions.mdx create mode 100644 docs/development/reference/python-sdk/platform/PlatformClient.mdx create mode 100644 docs/development/reference/python-sdk/platform/Provider.mdx create mode 100644 docs/development/reference/python-sdk/platform/ProviderBuild.mdx create mode 100644 docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx create mode 100644 docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx create mode 100644 docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx create mode 100644 docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx create mode 100644 docs/development/reference/python-sdk/platform/SystemConfiguration.mdx create mode 100644 docs/development/reference/python-sdk/platform/UpdateProvider.mdx create mode 100644 docs/development/reference/python-sdk/platform/User.mdx create mode 100644 docs/development/reference/python-sdk/platform/UserFeedback.mdx create mode 100644 docs/development/reference/python-sdk/platform/UserRole.mdx create mode 100644 docs/development/reference/python-sdk/platform/Variables.mdx create mode 100644 docs/development/reference/python-sdk/platform/VectorStore.mdx create mode 100644 docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx create mode 100644 docs/development/reference/python-sdk/platform/VectorStoreItem.mdx create mode 100644 docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx create mode 100644 docs/development/reference/python-sdk/platform/VectorStoreStats.mdx create mode 100644 docs/development/reference/python-sdk/platform/VersionInfo.mdx create mode 100644 docs/development/reference/python-sdk/platform/get_platform_client.mdx create mode 100644 docs/development/reference/python-sdk/platform/set_platform_client.mdx create mode 100644 docs/development/reference/python-sdk/platform/use_platform_client.mdx create mode 100644 docs/development/reference/python-sdk/platform/uuid_to_str.mdx create mode 100644 docs/development/reference/python-sdk/platform/validate_metadata.mdx create mode 100644 docs/development/reference/python-sdk/server.mdx create mode 100644 docs/development/reference/python-sdk/server/Agent.mdx create mode 100644 docs/development/reference/python-sdk/server/AgentExecuteFn.mdx create mode 100644 docs/development/reference/python-sdk/server/AgentRun.mdx create mode 100644 docs/development/reference/python-sdk/server/ContextStore.mdx create mode 100644 docs/development/reference/python-sdk/server/ContextStoreInstance.mdx create mode 100644 docs/development/reference/python-sdk/server/Depends.mdx create mode 100644 docs/development/reference/python-sdk/server/Executor.mdx create mode 100644 docs/development/reference/python-sdk/server/InMemoryContextStore.mdx create mode 100644 docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx create mode 100644 docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx create mode 100644 docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx create mode 100644 docs/development/reference/python-sdk/server/PlatformContextStore.mdx create mode 100644 docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx create mode 100644 docs/development/reference/python-sdk/server/RunContext.mdx create mode 100644 docs/development/reference/python-sdk/server/Server.mdx create mode 100644 docs/development/reference/python-sdk/server/cancel_task.mdx create mode 100644 docs/development/reference/python-sdk/server/close_queue.mdx create mode 100644 docs/development/reference/python-sdk/server/configure_telemetry.mdx create mode 100644 docs/development/reference/python-sdk/server/create_app.mdx create mode 100644 docs/development/reference/python-sdk/server/discover_jwks.mdx create mode 100644 docs/development/reference/python-sdk/server/extract_dependencies.mdx create mode 100644 docs/development/reference/python-sdk/types.mdx create mode 100644 docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx create mode 100644 docs/development/reference/python-sdk/util.mdx create mode 100644 docs/development/reference/python-sdk/util/BearerAuth.mdx create mode 100644 docs/development/reference/python-sdk/util/ColoredFormatter.mdx create mode 100644 docs/development/reference/python-sdk/util/LoadedFile.mdx create mode 100644 docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx create mode 100644 docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx create mode 100644 docs/development/reference/python-sdk/util/PlatformFileUrl.mdx create mode 100644 docs/development/reference/python-sdk/util/SecureBaseModel.mdx create mode 100644 docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx create mode 100644 docs/development/reference/python-sdk/util/configure_logger.mdx create mode 100644 docs/development/reference/python-sdk/util/extract_messages.mdx create mode 100644 docs/development/reference/python-sdk/util/filter_dict.mdx create mode 100644 docs/development/reference/python-sdk/util/flatten_dict.mdx create mode 100644 docs/development/reference/python-sdk/util/load_file.mdx create mode 100644 docs/development/reference/python-sdk/util/parse_stream.mdx create mode 100644 docs/development/reference/python-sdk/util/redact_dict.mdx create mode 100644 docs/development/reference/python-sdk/util/redact_secret.mdx create mode 100644 docs/development/reference/python-sdk/util/redact_str.mdx create mode 100644 docs/development/reference/python-sdk/util/redact_url.mdx create mode 100644 docs/development/reference/python-sdk/util/resource_context.mdx create mode 100644 docs/development/reference/python-sdk/util/should_redact.mdx create mode 100644 docs/development/reference/python-sdk/util/should_reveal.mdx create mode 100644 docs/development/reference/python-sdk/util/trace_class.mdx create mode 100644 docs/development/reference/python-sdk/util/trace_function.mdx create mode 100644 docs/development/reference/python-sdk/util/utc_now.mdx diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py new file mode 100644 index 0000000000..048809354f --- /dev/null +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -0,0 +1,628 @@ +#!/usr/bin/env python3 +# Copyright 2025 © BeeAI a Series of LF Projects, LLC +# SPDX-License-Identifier: Apache-2.0 +"""Generate Python SDK reference docs (MDX) from exports_structure.json. + +Uses Jinja2 templates from the docs_templates/ directory. +Run `uv run python introspect_exports.py` first to produce exports_structure.json. + +Usage: uv run python generate_docs.py +""" + +from __future__ import annotations + +import argparse +import json +from collections import OrderedDict +from functools import partial +from pathlib import Path + +from jinja2 import Environment, FileSystemLoader + +# --------------------------------------------------------------------------- +# Paths (module-level defaults; all can be overridden via CLI flags) +# --------------------------------------------------------------------------- + +AUTOGEN_WARNING = """\ +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/}""" + +# --------------------------------------------------------------------------- +# Page configuration +# --------------------------------------------------------------------------- + +# The five top-level modules shown on the overview page. +TOP_MODULES = [ + { + "title": "Server", + "description": "Core server for creating and running A2A-compatible agents", + "filename": "server", + }, + { + "title": "A2A", + "description": "Extensions for authentication, services, tools, UI, and interactions", + "filename": "a2a", + }, + { + "title": "Platform API", + "description": "Clients for files, vector stores, contexts, providers, and more", + "filename": "platform", + }, + { + "title": "Types", + "description": "Core type definitions and base classes", + "filename": "types", + }, + { + "title": "Utilities", + "description": "Utility helpers", + "filename": "util", + }, +] + +# Each entry drives a single .mdx page. +# +# json_key – key in exports_structure.json to pull items from; None = index-only page +# filename – output filename (no .mdx extension) +# title – MDX frontmatter title +# description – MDX frontmatter description +# import_path – Python import path shown in the code snippet +# submodule_cards – optional list of child modules rendered as a card grid +# group_by_origin – split items into sections per origin sub-module (used for platform) +PAGE_CONFIG: list[dict] = [ + # ── server ──────────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.server", + "filename": "server", + "title": "Server", + "description": "Core server for creating and running A2A-compatible agents", + "import_path": "agentstack_sdk.server", + }, + # ── a2a (index, items live in sub-pages) ────────────────────────────────── + { + "json_key": None, + "filename": "a2a", + "title": "A2A Extensions", + "description": "Extensions for the A2A protocol — authentication, services, tools, UI, and interactions", + "import_path": "agentstack_sdk.a2a.extensions", + "submodule_cards": [ + {"title": "Auth", "filename": "a2a-auth", "description": "OAuth and secrets authentication"}, + {"title": "Common", "filename": "a2a-common", "description": "Shared base classes and form types"}, + {"title": "Interactions", "filename": "a2a-interactions", "description": "Human-in-the-loop interaction extensions"}, + {"title": "Services", "filename": "a2a-services", "description": "LLM, embedding, MCP, and platform services"}, + {"title": "Tools", "filename": "a2a-tools", "description": "Tool call approval extensions"}, + {"title": "UI", "filename": "a2a-ui", "description": "Rich UI component extensions"}, + ], + }, + # ── a2a.auth (index) ────────────────────────────────────────────────────── + { + "json_key": None, + "filename": "a2a-auth", + "title": "Auth Extensions", + "description": "OAuth and secrets authentication extensions", + "import_path": "agentstack_sdk.a2a.extensions.auth", + "submodule_cards": [ + {"title": "OAuth", "filename": "a2a-auth-oauth", "description": "OAuth 2.0 flow extensions"}, + {"title": "Secrets", "filename": "a2a-auth-secrets", "description": "Secrets injection extensions"}, + ], + }, + # ── a2a.auth.oauth ──────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.auth.oauth", + "filename": "a2a-auth-oauth", + "title": "OAuth Extensions", + "description": "OAuth 2.0 flow extensions", + "import_path": "agentstack_sdk.a2a.extensions.auth.oauth", + "submodule_cards": [ + { + "title": "OAuth Storage", + "filename": "a2a-auth-oauth-storage", + "description": "Storage backends for OAuth flow state", + } + ], + }, + # ── a2a.auth.oauth.storage ──────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.auth.oauth.storage", + "filename": "a2a-auth-oauth-storage", + "title": "OAuth Storage", + "description": "Storage backends for OAuth flow state", + "import_path": "agentstack_sdk.a2a.extensions.auth.oauth.storage", + }, + # ── a2a.auth.secrets ────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.auth.secrets", + "filename": "a2a-auth-secrets", + "title": "Secrets Extensions", + "description": "Secrets injection extensions", + "import_path": "agentstack_sdk.a2a.extensions.auth.secrets", + }, + # ── a2a.common ──────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.common", + "filename": "a2a-common", + "title": "Common Types", + "description": "Shared base classes and form types for extensions", + "import_path": "agentstack_sdk.a2a.extensions.common", + }, + # ── a2a.interactions ────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.interactions", + "filename": "a2a-interactions", + "title": "Interaction Extensions", + "description": "Human-in-the-loop interaction extensions", + "import_path": "agentstack_sdk.a2a.extensions.interactions", + }, + # ── a2a.services ────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.services", + "filename": "a2a-services", + "title": "Service Extensions", + "description": "LLM, embedding, MCP, and platform service extensions", + "import_path": "agentstack_sdk.a2a.extensions.services", + }, + # ── a2a.tools ───────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.tools", + "filename": "a2a-tools", + "title": "Tool Extensions", + "description": "Tool call approval extensions", + "import_path": "agentstack_sdk.a2a.extensions.tools", + }, + # ── a2a.ui ──────────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.a2a.extensions.ui", + "filename": "a2a-ui", + "title": "UI Extensions", + "description": "Rich UI component extensions", + "import_path": "agentstack_sdk.a2a.extensions.ui", + }, + # ── platform (grouped by sub-module) ────────────────────────────────────── + { + "json_key": "agentstack_sdk.platform", + "filename": "platform", + "title": "Platform API", + "description": "Clients for files, vector stores, contexts, providers, and more", + "import_path": "agentstack_sdk.platform", + "group_by_origin": True, + }, + # ── types ───────────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.types", + "filename": "types", + "title": "SDK Types", + "description": "Core type definitions and base classes", + "import_path": "agentstack_sdk.types", + }, + # ── util ────────────────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.util", + "filename": "util", + "title": "Utilities", + "description": "Utility helpers", + "import_path": "agentstack_sdk.util", + }, +] + +# --------------------------------------------------------------------------- +# Jinja2 custom filters +# --------------------------------------------------------------------------- + +_TYPE_PREFIXES = ( + "agentstack_sdk.a2a.extensions.common.form.", + "agentstack_sdk.a2a.extensions.auth.oauth.oauth.", + "agentstack_sdk.a2a.extensions.auth.secrets.secrets.", + "agentstack_sdk.a2a.extensions.", + "agentstack_sdk.a2a.", + "agentstack_sdk.server.", + "agentstack_sdk.platform.", + "agentstack_sdk.", + "a2a.types.", + "collections.abc.", + "typing.", + "typing_extensions.", + "datetime.", + "uuid.", + "pydantic.", + "starlette.", + "httpx.", + "ssl.", + "os.", + "contextlib.", + "abc.", +) + + +def _shorten_type(s: str | None) -> str: + if not s: + return "" + for prefix in _TYPE_PREFIXES: + s = s.removeprefix(prefix) + return s + + +def _first_line(text: str | None) -> str: + if not text: + return "" + line = text.strip().split("\n")[0].strip().rstrip(".") + return line.replace('"', "'") # safe for MDX attribute strings + + +def _extra_lines(text: str | None) -> str: + if not text: + return "" + lines = text.strip().split("\n") + return "\n".join(lines[1:]).strip() if len(lines) > 1 else "" + + +def _sig_params(params: list[dict] | None, max_params: int | None = None) -> str: + """Parameter names only — keeps accordion titles short.""" + if not params: + return "" + if max_params is not None: + return ", ".join(p["name"] for p in params[:max_params]) + ("..." if len(params) > max_params else "") + else: + return ", ".join(p["name"] for p in params) + + +def _truncate_val(val: str | None, max_len: int = 40) -> str: + if not val: + return "" + return val[:max_len] + "..." if len(val) > max_len else val + + +def _table_type(s: str | None) -> str: + """Shorten a type annotation and escape | so it doesn't break Markdown table columns.""" + result = _shorten_type(s) + return result.replace("|", "\\|") + + +def _mdx_escape(text: str | None) -> str: + """Escape characters that MDX/acorn would try to parse as JSX expressions.""" + if not text: + return "" + return text.replace("{", "\\{").replace("}", "\\}") + + +# --------------------------------------------------------------------------- +# Item helpers +# --------------------------------------------------------------------------- + +_SKIP_KINDS = {"unknown"} + +# --------------------------------------------------------------------------- +# Module → filename / import_path look-up (built lazily from PAGE_CONFIG) +# --------------------------------------------------------------------------- + +_JSON_KEY_TO_FILENAME: dict[str, str] = {} +_JSON_KEY_TO_IMPORT_PATH: dict[str, str] = {} +_FILENAME_TO_TITLE: dict[str, str] = {} +_FILENAME_TO_PARENT: dict[str, str] = {} # child filename → parent filename + + +def _ensure_module_maps() -> None: + if _JSON_KEY_TO_FILENAME: + return + for cfg in PAGE_CONFIG: + key = cfg.get("json_key") + if key: + _JSON_KEY_TO_FILENAME[key] = cfg["filename"] + _JSON_KEY_TO_IMPORT_PATH[key] = cfg["import_path"] + _FILENAME_TO_TITLE[cfg["filename"]] = cfg["title"] + for card in cfg.get("submodule_cards", []): + _FILENAME_TO_PARENT[card["filename"]] = cfg["filename"] + + +def _symbol_breadcrumb_ancestors(parent_filename: str) -> list[tuple[str, str]]: + """Return ordered list of (title, filename) ancestors from root down to *parent_filename* (inclusive).""" + _ensure_module_maps() + chain: list[tuple[str, str]] = [] + current = parent_filename + while current: + title = _FILENAME_TO_TITLE.get(current, current.replace("-", " ").title()) + chain.append((title, current)) + current = _FILENAME_TO_PARENT.get(current, "") + chain.reverse() + return chain + + +def _find_longest_matching_json_key(origin: str) -> str | None: + """Return the longest PAGE_CONFIG json_key that is a prefix of *origin*.""" + _ensure_module_maps() + best_key: str | None = None + best_len = 0 + for key in _JSON_KEY_TO_FILENAME: + if (origin == key or origin.startswith(key + ".")) and len(key) > best_len: + best_key = key + best_len = len(key) + return best_key + + +def _symbol_import_path(item: dict) -> str: + """Best import path to use on a symbol's own page.""" + origin = item.get("origin", "") + longest = _find_longest_matching_json_key(origin) + if longest: + return _JSON_KEY_TO_IMPORT_PATH[longest] + # Fallback: use origin directly + return origin + + +def _symbol_page_parent_filename(item: dict) -> str: + """Filename of the parent module page for *item* (used as sub-directory).""" + origin = item.get("origin", "") + longest = _find_longest_matching_json_key(origin) + if longest: + return _JSON_KEY_TO_FILENAME[longest] + # Fallback: slugify origin + return origin.replace("agentstack_sdk.", "").replace(".", "-") + + +def _symbol_page_parent_title(parent_filename: str) -> str: + """Human-readable title of the parent module page.""" + _ensure_module_maps() + return _FILENAME_TO_TITLE.get(parent_filename, parent_filename.replace("-", " ").title()) + + + + +# --------------------------------------------------------------------------- +# Item helpers +# --------------------------------------------------------------------------- + + +def _split_items(items: list[dict]) -> tuple[list[dict], list[dict], list[dict]]: + classes = sorted([i for i in items if i.get("kind") == "class"], key=lambda i: i.get("name", "")) + functions = sorted([i for i in items if i.get("kind") == "function"], key=lambda i: i.get("name", "")) + constants = sorted([i for i in items if i.get("kind") not in ("class", "function")], key=lambda i: i.get("name", "")) + return classes, functions, constants + + +def _origin_submodule(item: dict, base_key: str) -> str: + origin = item.get("origin", "") + prefix = base_key + "." + if origin.startswith(prefix): + return origin[len(prefix):].split(".")[0] + return "" + + +def _import_example(import_path: str, classes: list[dict], functions: list[dict]) -> str: + names = [i["name"] for i in (classes + functions)[:3]] + if not names: + return f"from {import_path} import ..." + suffix = " # ..." if len(classes) + len(functions) > 3 else "" + return f"from {import_path} import {', '.join(names)}{suffix}" + + +def _build_group(title: str, import_path: str, items: list[dict]) -> dict: + classes, functions, constants = _split_items(items) + return { + "title": title, + "import_path": import_path, + "import_example": _import_example(import_path, classes, functions), + "classes": classes, + "functions": functions, + "constants": constants, + } + + +# --------------------------------------------------------------------------- +# Rendering +# --------------------------------------------------------------------------- + + +def _make_env(templates_dir: Path) -> Environment: + env = Environment( + loader=FileSystemLoader(str(templates_dir)), + autoescape=False, + trim_blocks=True, + lstrip_blocks=True, + ) + env.filters["first_line"] = _first_line + env.filters["extra_lines"] = _extra_lines + env.filters["shorten_type"] = _shorten_type + env.filters["table_type"] = _table_type + env.filters["mdx_escape"] = _mdx_escape + env.filters["sig_params"] = _sig_params + env.filters["sig_params_short"] = partial(_sig_params, max_params=4) + env.filters["truncate_val"] = _truncate_val + return env + + +def render_overview(env: Environment, version: str) -> str: + tmpl = env.get_template("overview.mdx.j2") + return tmpl.render( + autogen_warning=AUTOGEN_WARNING, + top_modules=TOP_MODULES, + base_href=f"/{version}/reference/python-sdk", + ) + + +def render_page(env: Environment, cfg: dict, data: dict, version: str) -> str: + json_key: str | None = cfg.get("json_key") + import_path: str = cfg["import_path"] + submodule_cards: list[dict] = cfg.get("submodule_cards", []) + group_by_origin: bool = cfg.get("group_by_origin", False) + base_href = f"/{version}/reference/python-sdk" + symbol_base_href = f"{base_href}/{cfg['filename']}" + + items: list[dict] = [] + if json_key and json_key in data: + items = [i for i in data[json_key] if i.get("kind") not in _SKIP_KINDS] + + groups: list[dict] = [] + if items: + if group_by_origin: + grouped: dict[str, list[dict]] = OrderedDict() + for item in items: + sub = _origin_submodule(item, json_key or "") + grouped.setdefault(sub, []).append(item) + for sub, sub_items in grouped.items(): + sub_title = sub.replace("_", " ").title() if sub else "" + sub_import = f"{import_path}.{sub}" if sub else import_path + groups.append(_build_group(sub_title, sub_import, sub_items)) + else: + groups.append(_build_group("", import_path, items)) + + all_classes = [c for g in groups for c in g["classes"]] + all_functions = [f for g in groups for f in g["functions"]] + import_example = _import_example(import_path, all_classes, all_functions) if items else "" + + tmpl = env.get_template("module.mdx.j2") + return tmpl.render( + autogen_warning=AUTOGEN_WARNING, + title=cfg["title"], + description=cfg["description"], + import_path=import_path, + import_example=import_example, + submodule_cards=submodule_cards, + groups=groups, + base_href=base_href, + symbol_base_href=symbol_base_href, + ) + + +# --------------------------------------------------------------------------- +# Symbol-level page renderers +# --------------------------------------------------------------------------- + + +def render_class_page( + env: Environment, + cls: dict, + import_path: str, + breadcrumb_ancestors: list[tuple[str, str]] | None = None, + base_href: str = "", +) -> str: + tmpl = env.get_template("class.mdx.j2") + return tmpl.render( + autogen_warning=AUTOGEN_WARNING, + cls=cls, + import_path=import_path, + breadcrumb_ancestors=breadcrumb_ancestors or [], + base_href=base_href, + ) + + +def render_function_page( + env: Environment, + fn: dict, + import_path: str, + breadcrumb_ancestors: list[tuple[str, str]] | None = None, + base_href: str = "", +) -> str: + tmpl = env.get_template("function.mdx.j2") + return tmpl.render( + autogen_warning=AUTOGEN_WARNING, + fn=fn, + import_path=import_path, + breadcrumb_ancestors=breadcrumb_ancestors or [], + base_href=base_href, + ) + + + +# --------------------------------------------------------------------------- +# Main +# --------------------------------------------------------------------------- + + +def main() -> None: + parser = argparse.ArgumentParser(description="Generate Python SDK reference docs (MDX) from exports_structure.json.") + parser.add_argument( + "--json-file", + type=Path, + help="Path to the exports_structure.json manifest", + ) + parser.add_argument( + "--docs-dir", + type=Path, + help=f"Root docs output directory", + ) + parser.add_argument( + "--templates-dir", + type=Path, + help=f"Jinja2 templates directory", + ) + args = parser.parse_args() + + json_file: Path = args.json_file + docs_dir: Path = args.docs_dir + templates_dir: Path = args.templates_dir + + if not json_file.exists(): + raise FileNotFoundError( + f"exports_structure.json not found at {json_file}.\n" + "Run `mise x -- uv run introspect_exports.py` first." + ) + + data = json.loads(json_file.read_text()) + env = _make_env(templates_dir) + _ensure_module_maps() + + version = "development" + out_dir = docs_dir / version / "reference" / "python-sdk" + out_dir.mkdir(parents=True, exist_ok=True) + + # ── overview + module pages (as before) ────────────────────────────────── + content = render_overview(env, version) + (out_dir / "overview.mdx").write_text(content) + + for cfg in PAGE_CONFIG: + content = render_page(env, cfg, data, version) + (out_dir / f"{cfg['filename']}.mdx").write_text(content) + + # ── auto-generated symbol pages ─────────────────────────────────────────── + # Collect all unique symbols across every module key in the JSON. + # Dedup by (name, origin) so each real symbol gets exactly one page, + # placed under the most specific matching PAGE_CONFIG module directory. + generated_symbols: set[tuple[str, str]] = set() + symbol_count = 0 + + for json_key, items in data.items(): + for item in items: + kind = item.get("kind") + if kind in _SKIP_KINDS: + continue + name: str = item.get("name", "") + origin: str = item.get("origin", json_key) + if not name: + continue + + dedup_key = (name, origin) + if dedup_key in generated_symbols: + continue + generated_symbols.add(dedup_key) + + import_path = _symbol_import_path(item) + parent_filename = _symbol_page_parent_filename(item) + base_href = f"/{version}/reference/python-sdk" + breadcrumb_ancestors = _symbol_breadcrumb_ancestors(parent_filename) + + symbol_dir = out_dir / parent_filename + symbol_dir.mkdir(parents=True, exist_ok=True) + + if kind == "class": + content = render_class_page(env, item, import_path, breadcrumb_ancestors, base_href) + elif kind == "function": + content = render_function_page(env, item, import_path, breadcrumb_ancestors, base_href) + else: + continue + + (symbol_dir / f"{name}.mdx").write_text(content) + symbol_count += 1 + + module_count = 1 + len(PAGE_CONFIG) + print( + f"\nGenerated {module_count} module pages + {symbol_count} symbol pages" + f" in {version}/reference/python-sdk/" + ) + + +if __name__ == "__main__": + main() diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py new file mode 100644 index 0000000000..06e80b20dc --- /dev/null +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -0,0 +1,760 @@ +#!/usr/bin/env python +""" +Trace the public API of agentstack-sdk-py by following star-import chains, +then enrich each discovered name with griffe metadata. +""" + +from __future__ import annotations + +import ast +import enum +import json +import re +import sys +from pathlib import Path +from typing import Any +from pydantic import BaseModel, ConfigDict + +import argparse + +import griffe + + + + + +class ExportItem(BaseModel): + model_config = ConfigDict(validate_assignment=True) + + name: str + origin: str + kind: str | None = None + docstring: str | None = None + annotation: str | None = None + definition: str | None = None + default: str | None = None + params: list[dict[str, Any]] | None = None + returns: str | None = None + bases: list[str] | None = None + class_attributes: list[dict[str, Any]] | None = None + attributes: list[dict[str, Any]] | None = None + methods: list[dict[str, Any]] | None = None + labels: list[str] | None = None + + +def parse_allnames(tree: ast.Module) -> list[str]: + """Extract string names from a top-level __all__ = [...] assignment.""" + for node in tree.body: + if ( + isinstance(node, ast.Assign) + and len(node.targets) == 1 + and isinstance(node.targets[0], ast.Name) + and node.targets[0].id == "__all__" + and isinstance(node.value, ast.List) + ): + return [ + elt.value + for elt in node.value.elts + if isinstance(elt, ast.Constant) and isinstance(elt.value, str) + ] + return [] + + +def resolve_absolute(module_path: str) -> Path | None: + """ + Resolve an absolute dotted module path to a filesystem path, but only + if the module lives inside the same package (SRC_ROOT). + """ + pkg_name = SRC_ROOT.name # e.g. "agentstack_sdk" + if not module_path.startswith(pkg_name): + return None + parts = module_path.split(".") + candidate: Path = SRC_ROOT.parent + for part in parts: + candidate = candidate / part + if (candidate / "__init__.py").exists(): + return candidate + if candidate.with_suffix(".py").exists(): + return candidate.with_suffix(".py") + return None + + +def resolve_relative(current_pkg_path: Path, level: int, module_suffix: str | None) -> Path | None: + """ + Resolve a relative import to an absolute filesystem path. + + current_pkg_path: directory of the package containing the importing file + level: number of leading dots (1 = current package, 2 = parent, ...) + module_suffix: the `X.Y` part after the dots, or None + Returns: Path to the resolved .py file or package directory, or None if not found. + """ + base = current_pkg_path + for _ in range(level - 1): + base = base.parent + + if module_suffix: + parts = module_suffix.split(".") + candidate = base + for part in parts: + candidate = candidate / part + else: + candidate = base + + # Prefer package (directory with __init__.py) over plain module + if (candidate / "__init__.py").exists(): + return candidate + if candidate.with_suffix(".py").exists(): + return candidate.with_suffix(".py") + return None + + +def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportItem]: + """ + Recursively collect effective exports from a file or package directory. + + path: either a .py file or a package directory (containing __init__.py) + Returns a deduplicated list of ExportItem(name, origin). + """ + if visited is None: + visited = set() + + # Normalise to the actual file we'll parse + if path.is_dir(): + parse_file = path / "__init__.py" + pkg_dir = path + else: + parse_file = path + pkg_dir = path.parent + + str_path = str(parse_file) + if str_path in visited: + return [] + visited.add(str_path) + + if not parse_file.exists(): + return [] + + source = parse_file.read_text() + try: + tree = ast.parse(source) + except SyntaxError as exc: + print(f" ⚠ SyntaxError in {parse_file}: {exc}", file=sys.stderr) + return [] + + exports: list[ExportItem] = [] + origin = _path_to_module(parse_file) + + # ── 1. Check for an explicit __all__ ──────────────────────────────────── + declared = parse_allnames(tree) + if declared: + for name in declared: + exports.append(ExportItem(name=name, origin=origin)) + # An explicit __all__ is the final word – no need to follow star imports + return _deduplicate(exports) + + # ── 2. No __all__: follow star imports, explicit re-exports, and local definitions ─────────── + for node in tree.body: + # ── locally defined classes ────────────────────────────────────────── + if isinstance(node, ast.ClassDef): + if not node.name.startswith("_"): + exports.append(ExportItem(name=node.name, origin=origin)) + continue + + # ── locally defined functions ──────────────────────────────────────── + if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)): + if not node.name.startswith("_"): + exports.append(ExportItem(name=node.name, origin=origin)) + continue + + # ── module-level assignments (constants and variables) ─────────────── + if isinstance(node, ast.Assign): + for target in node.targets: + if isinstance(target, ast.Name) and not target.id.startswith("_"): + exports.append(ExportItem(name=target.id, origin=origin)) + continue + + if isinstance(node, ast.AnnAssign): + target = node.target + if isinstance(target, ast.Name) and not target.id.startswith("_"): + exports.append(ExportItem(name=target.id, origin=origin)) + continue + + if not isinstance(node, ast.ImportFrom): + continue + + # Only handle relative imports (level > 0) + if node.level == 0: + # ── absolute star import from within the same package ──────────── + if node.names and node.names[0].name == "*" and node.module: + resolved_abs = resolve_absolute(node.module) + if resolved_abs is not None: + child_exports = collect_exports(resolved_abs, visited) + exports.extend(child_exports) + else: + # Capture intentional `Name as Name` re-exports + for alias in node.names: + if alias.name != "*" and alias.asname == alias.name: + exports.append(ExportItem(name=alias.name, origin=node.module or "")) + continue + + # ── relative wildcard: `from .X import *` ─────────────────────────── + resolved = resolve_relative(pkg_dir, node.level, node.module) + if node.names[0].name == "*": + if resolved is None: + print( + f" ⚠ Cannot resolve relative import " + f"{'.' * node.level}{node.module or ''} in {parse_file}", + file=sys.stderr, + ) + continue + child_exports = collect_exports(resolved, visited) + exports.extend(child_exports) + + # ── relative explicit: `from .X import Name as Name` ──────────────── + else: + resolved_module = _path_to_module(resolved) if resolved else (node.module or "") + for alias in node.names: + if alias.name != "*": + exports.append(ExportItem(name=alias.asname or alias.name, origin=resolved_module)) + + return _deduplicate(exports) + + +def _path_to_module(path: Path | None) -> str: + """Convert an absolute path under SRC_ROOT.parent to a dotted module name.""" + if path is None: + return "" + try: + rel = path.relative_to(SRC_ROOT.parent) + except ValueError: + return str(path) + parts = list(rel.parts) + if parts[-1] == "__init__.py": + parts = parts[:-1] + elif parts[-1].endswith(".py"): + parts[-1] = parts[-1][:-3] + return ".".join(parts) + + +def _deduplicate(exports: list[ExportItem]) -> list[ExportItem]: + seen: set[str] = set() + result: list[ExportItem] = [] + for exp in exports: + if exp.name not in seen: + seen.add(exp.name) + result.append(exp) + return result + + +def _init_imports_file(init_file: Path, module_stem: str) -> bool: + """ + Return True if *init_file* contains any import that explicitly references + a sibling module named *module_stem* (e.g. "types"). + + Matches relative imports of the form: + from .types import ... + from . import types + """ + if not init_file.exists(): + return False + try: + tree = ast.parse(init_file.read_text()) + except SyntaxError: + return False + for node in tree.body: + if not isinstance(node, ast.ImportFrom): + continue + if node.level == 0: + continue + # `from .types import ...` → node.module == "types" + if node.module == module_stem: + return True + # `from . import types` → node.module is None, names contain "types" + if node.module is None and any(alias.name == module_stem for alias in node.names): + return True + return False + + +def trace_package(root: Path) -> dict[str, list[ExportItem]]: + """ + Walk every __init__.py in the package and compute its effective public API. + Also picks up flat .py modules anywhere in the package tree that are NOT + already referenced (imported) by the sibling __init__.py. + Returns {dotted_module_path: [ExportItem, ...]}. + """ + result: dict[str, list[ExportItem]] = {} + + for init_file in sorted(root.rglob("__init__.py")): + if "__pycache__" in init_file.parts: + continue + pkg_dir = init_file.parent + module_name = _path_to_module(pkg_dir) + exports = collect_exports(pkg_dir) # fresh visited set per package + result[module_name] = exports + + # Also pick up flat .py modules anywhere in the package tree (e.g. a2a/types.py). + # Skip a file if the sibling __init__.py already imports from it — those + # exports are already captured via the package entry above. + for py_file in sorted(root.rglob("*.py")): + if py_file.name == "__init__.py" or py_file.name.startswith("_"): + continue + if "__pycache__" in py_file.parts: + continue + module_name = _path_to_module(py_file) + if module_name in result: + continue + sibling_init = py_file.parent / "__init__.py" + if _init_imports_file(sibling_init, py_file.stem): + continue + exports = collect_exports(py_file) + if exports: + result[module_name] = exports + + return result + + +# ── Griffe enrichment ────────────────────────────────────────────────────── + + +def _fmt_annotation(ann: Any) -> str | None: + """Stringify a griffe annotation, keeping package prefixes.""" + if ann is None: + return None + s = str(ann) + return s or None + + +def _fmt_docstring(ds: griffe.Docstring | None) -> str | None: + if not ds or not ds.value: + return None + text = ds.value.strip() + return text + + +FILTER_FUNCTION_LABELS = {"module-attribute"} + +def _serialize_function(fn: griffe.Function) -> dict[str, Any]: + params = [] + for p in fn.parameters: + if p.name in ("self", "cls"): + continue + entry: dict[str, Any] = {"name": p.name} + if p.annotation: + entry["type"] = _fmt_annotation(p.annotation) + if p.default is not None and str(p.default) not in ("None", "PosOnlyArgsSep", "KwOnlyArgsSep"): + entry["default"] = str(p.default) + entry["kind"] = p.kind.value if p.kind and hasattr(p.kind, "value") else str(p.kind) + params.append(entry) + + result: dict[str, Any] = {"kind": "function", "params": params} + if fn.returns: + result["returns"] = _fmt_annotation(fn.returns) + doc = _fmt_docstring(fn.docstring) + if doc: + result["docstring"] = doc + if fn.labels: + result["labels"] = sorted(str(l) for l in fn.labels if str(l) not in FILTER_FUNCTION_LABELS) + return result + + +def _identify_arguments_from_init(method: griffe.Function) -> list[dict[str, Any]]: + assigns: list[dict[str, Any]] = [] + try: + src = method.source + if src: + tree = ast.parse(src) + for node in ast.walk(tree): + if isinstance(node, ast.Assign): + for target in node.targets: + if ( + isinstance(target, ast.Attribute) + and isinstance(target.value, ast.Name) + and target.value.id == "self" + and not target.attr.startswith("_") + ): + assigns.append({"name": target.attr}) + elif isinstance(node, ast.AnnAssign): + if ( + isinstance(node.target, ast.Attribute) + and isinstance(node.target.value, ast.Name) + and node.target.value.id == "self" + and not node.target.attr.startswith("_") + ): + entry: dict[str, Any] = {"name": node.target.attr} + if node.annotation: + entry["type"] = ast.unparse(node.annotation) + assigns.append(entry) + except Exception: + pass + return assigns + + +def _is_factory_classmethod(method: griffe.Function, class_name: str) -> bool: + """ + Return True if *method* is a @classmethod whose return annotation is + exactly "Self" or the enclosing class name. + """ + if "classmethod" not in {str(l) for l in method.labels}: + return False + ret = _fmt_annotation(method.returns) + if not ret: + return False + + core = ret.strip() + # Accept bare "Self" or any qualified variant (typing.Self, typing_extensions.Self) + # as well as the exact class name. + return core in (class_name, "Self") or core.endswith(".Self") + + +def _serialize_class(cls: griffe.Class) -> dict[str, Any]: + result: dict[str, Any] = {"kind": "class"} + + bases = [_fmt_annotation(b) for b in cls.bases if _fmt_annotation(b) not in ("object", None)] + if bases: + result["bases"] = bases + + doc = _fmt_docstring(cls.docstring) + if doc: + result["docstring"] = doc + + # Fields (class-level attributes, excluding private and dunder) + class_attrs = [] + for name, member in cls.members.items(): + if name.startswith("_"): + continue + actual = member + + if isinstance(member, griffe.Alias): + try: + actual = member.target + except Exception: + continue + + if actual.kind.name != "ATTRIBUTE": + continue + field: dict[str, Any] = {"name": name} + ann = getattr(actual, "annotation", None) + if ann: + field["type"] = _fmt_annotation(ann) + field_doc = _fmt_docstring(actual.docstring) + if field_doc: + field["docstring"] = field_doc + val = getattr(actual, "value", None) + if val is not None: + v = str(val) + if len(v) <= 120: + field["default"] = v + class_attrs.append(field) + if class_attrs: + result["class_attributes"] = class_attrs + + # Public methods (excluding dunder, but including __init__) + methods = [] + for name, member in cls.members.items(): + if name.startswith("_") and name != "__init__": + continue + actual = member + if member.kind.name == "ALIAS": + if hasattr(member, "target"): + actual = member.target + else: + continue + if actual.kind.name != "FUNCTION": + continue + method_info: dict[str, Any] = {"name": name} + if name == "__init__": + method_info["kind"] = "constructor" + # Find self.attribute assignments in the __init__ body + assigned_attributes = _identify_arguments_from_init(actual) # pyrefly: ignore[bad-argument-type] + if assigned_attributes: + class_attrs_names = {attr["name"] for attr in class_attrs} + result["attributes"] = [aa for aa in assigned_attributes if aa["name"] not in class_attrs_names] + + elif _is_factory_classmethod(actual, cls.name): # pyrefly: ignore[bad-argument-type] + method_info["kind"] = "constructor" + else: + method_info["kind"] = "method" + params = [] + if hasattr(actual, "parameters") and actual.parameters: + for p in actual.parameters: + if p.name in ("self", "cls"): + continue + pe: dict[str, Any] = {"name": p.name} + if p.annotation: + pe["type"] = _fmt_annotation(p.annotation) + if p.default is not None and str(p.default) not in ("None", "PosOnlyArgsSep", "KwOnlyArgsSep"): + d = str(p.default) + pe["default"] = d if len(d) <= 80 else "..." + params.append(pe) + if params: + method_info["params"] = params + if hasattr(actual, "returns") and actual.returns: + method_info["returns"] = _fmt_annotation(actual.returns) + method_doc = _fmt_docstring(actual.docstring) + if method_doc: + method_info["docstring"] = method_doc + if actual.labels: + method_info["labels"] = sorted(str(l) for l in actual.labels) + methods.append(method_info) + if methods: + result["methods"] = methods + + return result + + +def _is_constant(name: str) -> bool: + """Check if a name follows the UPPER_SNAKE_CASE constant convention.""" + return bool(re.match(r'^[A-Z0-9_]+$', name)) + + +def _is_callable_annotation(ann_str: str | None) -> bool: + """Return True if the annotation string represents a Callable type.""" + if not ann_str: + return False + return bool(re.match(r'^(typing\.)?Callable\b', ann_str)) + +import enum + +class TypingKind(str, enum.Enum): + SPECIAL_FORM = "special_form" + TYPE_VAR = "type_var" + NEW_TYPE = "new_type" + TYPE_ALIAS = "type_alias" # PEP 613 / PEP 695 explicit alias + UNION_ALIAS = "union_alias" # A | B style + + +_SPECIAL_FORM_PREFIXES = [ + "Literal[", + "Union[", + "Optional[", + "Annotated[", + "Final[", + "ClassVar[", + "Concatenate[", +] + +_VALUE_PREFIX_TO_KIND: list[tuple[str, TypingKind]] = [ + *(("typing." + p, TypingKind.SPECIAL_FORM) for p in _SPECIAL_FORM_PREFIXES), + *((p, TypingKind.SPECIAL_FORM) for p in _SPECIAL_FORM_PREFIXES), + ("typing.TypeVar(", TypingKind.TYPE_VAR), + ("TypeVar(", TypingKind.TYPE_VAR), + ("typing.NewType(", TypingKind.NEW_TYPE), + ("NewType(", TypingKind.NEW_TYPE), +] + +_TYPE_ALIAS_ANNOTATION_NAMES = {"TypeAlias", "typing.TypeAlias", "typing_extensions.TypeAlias"} + +_UNION_TYPE_ALIAS_RE = re.compile(r"^[\w][\w\[\]., ]*(\s*\|\s*[\w][\w\[\]., ]*)+$") + + +def _get_typing_kind(attr: griffe.Attribute) -> str | None: + """Return the TypingKind of the attribute, or None if it's not a typing construct.""" + ann = getattr(attr, "annotation", None) + ann_str = _fmt_annotation(ann) + + # PEP 613 explicit: `Foo: TypeAlias = ...` + if ann_str and ann_str in _TYPE_ALIAS_ANNOTATION_NAMES: + return TypingKind.TYPE_ALIAS + + val = getattr(attr, "value", None) + if val is None: + return None + + val_str = str(val).strip() + + for prefix, kind in _VALUE_PREFIX_TO_KIND: + if val_str.startswith(prefix): + return kind + + if _UNION_TYPE_ALIAS_RE.match(val_str): + return TypingKind.UNION_ALIAS + + return None + + +def _serialize_attribute(attr: griffe.Attribute, name: str = "") -> dict[str, Any]: + """ + Serialize a module-level attribute/variable or constant. + + Callable-annotated attributes are serialised with kind="function". + Type alias assignments (typing.Literal, Union, TypeVar, etc.) are + serialised with kind="type_alias" and the actual type expression as "type". + Other attributes are distinguished as constants (UPPER_SNAKE_CASE) or + regular variables. + """ + ann = getattr(attr, "annotation", None) + ann_str = _fmt_annotation(ann) + + if _is_callable_annotation(ann_str): + result: dict[str, Any] = {"kind": "function", "annotation": ann_str} + doc = _fmt_docstring(attr.docstring) + if doc: + result["docstring"] = doc + if attr.labels: + result["labels"] = sorted(str(l) for l in attr.labels if str(l) not in FILTER_FUNCTION_LABELS) + return result + + if typing_kind := _get_typing_kind(attr): + val = getattr(attr, "value", None) + type_str = str(val).strip() if val is not None else ann_str + result = {"kind": typing_kind} + if type_str: + result["definition"] = type_str + doc = _fmt_docstring(attr.docstring) + if doc: + result["docstring"] = doc + return result + + kind = "constant" if _is_constant(name) else "attribute" + result: dict[str, Any] = {"kind": kind} + ann = getattr(attr, "annotation", None) + if ann: + result["annotation"] = _fmt_annotation(ann) + val = getattr(attr, "value", None) + if val is not None: + v = str(val) + if len(v) <= 200: + result["value"] = v + doc = _fmt_docstring(attr.docstring) + if doc: + result["docstring"] = doc + return result + + +def _lookup_griffe(pkg: griffe.Module, dotted_path: str, name: str) -> griffe.Object | None: + """Resolve dotted_path in the griffe module tree, then look up name.""" + try: + obj = pkg + # Strip the leading "agentstack_sdk." prefix if present + relative = dotted_path.removeprefix("agentstack_sdk.") + if relative and relative != "agentstack_sdk": + for part in relative.split("."): + obj = obj[part] + return obj[name] + except (KeyError, TypeError): + return None + + +_LOGGER_TYPE_NAMES = {"logging.Logger", "Logger", "logging.RootLogger", "RootLogger", "TypeVar", "typing.TypeVar"} + + +def _is_unwanted_attribute(attr: griffe.Attribute) -> bool: + """Return True if the attribute is a logging.Logger instance.""" + ann = getattr(attr, "annotation", None) + ann_str = _fmt_annotation(ann) + if ann_str and ann_str in _LOGGER_TYPE_NAMES: + return True + # Fallback: check the value expression (e.g. `logging.getLogger(...)`) + type_filter = { + "logging.getLogger", + "getLogger", + "TypeVar", + "typing.TypeVar", + } + val = getattr(attr, "value", None) + if val is not None: + val_str = str(val).strip() + if any(val_str.startswith(f"{prefix}(") for prefix in type_filter): + return True + return False + + +def enrich_api( + api: dict[str, list[ExportItem]], + pkg: griffe.Module, +) -> dict[str, list[dict[str, Any]]]: + """ + For every ExportItem in *api*, look up the object in the griffe tree and + attach rich metadata. Returns a JSON-serialisable dict. + """ + result: dict[str, list[dict[str, Any]]] = {} + + for module_path, exports in sorted(api.items()): + if not exports: + continue + enriched_exports = [] + for exp in exports: + member = _lookup_griffe(pkg, exp.origin, exp.name) + + # Resolve through aliases + if member is not None and member.kind.name == "ALIAS": + if hasattr(member, "target"): + member = member.target + else: + member = None + + if member is None: + exp.kind = "unknown" + enriched_exports.append(exp.model_dump(exclude_none=True)) + continue + + kind = member.kind.name + if kind == "CLASS": + exp = exp.model_copy(update=_serialize_class(member)) # pyrefly: ignore[bad-argument-type] + elif kind == "FUNCTION": + exp = exp.model_copy(update=_serialize_function(member)) # pyrefly: ignore[bad-argument-type] + elif kind == "ATTRIBUTE": + if _is_unwanted_attribute(member): # pyrefly: ignore[bad-argument-type] + continue + exp = exp.model_copy(update=_serialize_attribute(member, exp.name)) # pyrefly: ignore[bad-argument-type] + else: + exp.kind = kind.lower() + doc = _fmt_docstring(getattr(member, "docstring", None)) + if doc: + exp.docstring = doc + + enriched_exports.append(exp.model_dump(exclude_none=True)) + result[module_path] = enriched_exports + + return result + + +SRC_ROOT = "" + + +def main() -> None: + parser = argparse.ArgumentParser(description="Introspect agentstack-sdk-py exports and emit a JSON manifest.") + parser.add_argument( + "--src-root", + type=Path, + help="Path to the agentstack_sdk package source directory", + ) + parser.add_argument( + "--output", + "-o", + type=Path, + default=Path(__file__).resolve().parent / "exports_structure.json", + help="Path where the JSON manifest will be written (default: /exports_structure.json)", + ) + args = parser.parse_args() + + # Allow helper functions (resolve_absolute, _path_to_module) to use the + # correct source root when --src-root is overridden. + global SRC_ROOT + SRC_ROOT = args.src_root.resolve() + + if not SRC_ROOT.exists(): + sys.exit(f"Package source not found at {SRC_ROOT}") + + # ── Phase 1: star-import tracing ───────────────────────────────────────── + api = trace_package(SRC_ROOT) + + # ── Phase 2: griffe enrichment ─────────────────────────────────────────── + print("\nLoading package with griffe for metadata enrichment...") + + pkg = griffe.load("agentstack_sdk", search_paths=[str(SRC_ROOT.parent)]) + enriched = enrich_api(api, pkg) + print(" ✓ griffe enrichment complete") + + out_file: Path = args.output + out_file.parent.mkdir(parents=True, exist_ok=True) + out_file.write_text(json.dumps(enriched, indent=2)) + print(f"\n→ Saved to {out_file}") + + pkg_count = len(enriched) + name_count = sum(len(v) for v in enriched.values()) + print(f" {pkg_count} packages · {name_count} total exports") + + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 new file mode 100644 index 0000000000..70610e3c48 --- /dev/null +++ b/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 @@ -0,0 +1,99 @@ +--- +title: "{{ cls.name }}" +description: "{{ cls.docstring | first_line }}" +--- + +{{ autogen_warning }} +{%- if base_href and breadcrumb_ancestors %} + +[Python SDK Reference]({{ base_href }}/overview){% for title, filename in breadcrumb_ancestors %} / [{{ title }}]({{ base_href }}/{{ filename }}){% endfor %} / {{ cls.name }} +{%- endif %} + +```python +from {{ import_path }} import {{ cls.name }} +``` +{%- if cls.bases %} + +**Bases:** `{{ cls.bases | join(' , ') | shorten_type }}` +{%- endif %} +{%- if cls.docstring and cls.docstring | extra_lines %} + +{{ cls.docstring | extra_lines }} +{%- endif %} +{%- if cls.class_attributes %} + +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +{% for attr in cls.class_attributes %}| `{{ attr.name }}` | {% if attr.type %}`{{ attr.type | table_type }}`{% else %}—{% endif %} | {% if attr.default %}`{{ attr.default | truncate_val }}`{% else %}—{% endif %} | +{% endfor %} +{%- endif %} +{%- if cls.attributes %} + +## Attributes + +| Attribute | Type | Default | +|-------|------|---------| +{% for attr in cls.attributes %}| `{{ attr.name }}` | {% if attr.type %}`{{ attr.type | table_type }}`{% else %}—{% endif %} | {% if attr.default %}`{{ attr.default | truncate_val }}`{% else %}—{% endif %} | +{% endfor %} +{%- endif %} +{%- if cls.methods %} + +## Methods + + +{% for method in cls.methods %} +{%- if method.kind == 'constructor'%} + + +{%- if method.docstring %} + +{{ method.docstring | mdx_escape }} +{%- endif %} +{%- if method.params %} + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +{% for p in method.params %}| `{{ p.name }}` | {% if p.type %}`{{ p.type | table_type }}`{% else %}—{% endif %} | {% if p.default %}`{{ p.default | truncate_val }}`{% else %}—{% endif %} | +{% endfor %} +{%- endif %} +{%- if method.returns %} + +**Returns:** `{{ method.returns | shorten_type }}` + +{% endif %} + +{%- endif %} +{% endfor %} + + +{% for method in cls.methods %} +{%- if method.kind != 'constructor'%} + + +{%- if method.docstring %} + +{{ method.docstring | mdx_escape }} +{%- endif %} +{%- if method.params %} + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +{% for p in method.params %}| `{{ p.name }}` | {% if p.type %}`{{ p.type | table_type }}`{% else %}—{% endif %} | {% if p.default %}`{{ p.default | truncate_val }}`{% else %}—{% endif %} | +{% endfor %} +{%- endif %} +{%- if method.returns %} + +**Returns:** `{{ method.returns | shorten_type }}` + +{% endif %} + +{%- endif %} +{% endfor %} + +{%- endif %} diff --git a/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 new file mode 100644 index 0000000000..6c7303a915 --- /dev/null +++ b/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 @@ -0,0 +1,40 @@ +--- +title: "{{ fn.name }}" +description: "{{ fn.docstring | first_line }}" +--- + +{{ autogen_warning }} +{%- if base_href and breadcrumb_ancestors %} + +[Python SDK Reference]({{ base_href }}/overview){% for title, filename in breadcrumb_ancestors %} / [{{ title }}]({{ base_href }}/{{ filename }}){% endfor %} / {{ fn.name }} +{%- endif %} + +```python +from {{ import_path }} import {{ fn.name }} +``` +{%- if fn.labels %} + +Labels: {% for label in fn.labels %}`{{ label }}`{% if not loop.last %}, {% endif %}{% endfor %} +{%- endif %} +{%- if fn.docstring %} + +{{ fn.docstring }} +{%- endif %} +{%- if fn.params %} + +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------| +{%- for p in fn.params %} +| `{{ p.name }}` | {% if p.type %}`{{ p.type | shorten_type }}`{% else %}—{% endif %} | {% if p.default %}`{{ p.default | truncate_val }}`{% else %}—{% endif %} | {{ p.docstring | first_line if p.docstring else '' }} | +{%- endfor %} + +{%- endif %} +{%- if fn.returns %} + +## Returns + +`{{ fn.returns | shorten_type }}` + +{% endif %} diff --git a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 new file mode 100644 index 0000000000..609cd08a2e --- /dev/null +++ b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 @@ -0,0 +1,90 @@ +--- +title: "{{ title }}" +description: "{{ description }}" +--- + +{{ autogen_warning }} +{%- if import_example %} + +```python +{{ import_example }} +``` +{%- endif %} +{%- if submodule_cards %} + + +{%- for card in submodule_cards %} + + + {{ card.description }} + +{%- endfor %} + + +{%- endif %} +{%- for group in groups %} +{%- if group.title %} + +--- + +## {{ group.title }} + +```python +{{ group.import_example }} +``` + +{%- endif %} +{%- if group.classes %} +{%- if not group.title %} + +--- + +{%- endif %} + +### Classes + + +{%- for cls in group.classes %} + + + +{%- endfor %} + + + +{%- endif %} +{%- if group.functions %} +{%- if not group.title and not group.classes %} + +--- + +{%- endif %} + +### Functions + + +{%- for fn in group.functions %} + + + +{%- endfor %} + + + +{%- endif %} +{%- if group.constants %} +{%- if not group.title and not group.classes and not group.functions %} + +--- + +{%- endif %} + +### Constants & Variables + +| {% raw %}Name{% endraw %} | Kind | Type / Definition | +|------|------|------| +{% for attr in group.constants %}| `{{ attr.name }}` | *{{ attr.kind }}* | {% if attr.annotation %}`{{ attr.annotation | shorten_type | replace('|', '\|') }}`{% elif attr.definition %}`{{ attr.definition | shorten_type | replace('|', '\|') }}`{% else %}—{% endif %} | +{% endfor %} + +{%- endif %} +{%- endfor %} diff --git a/apps/agentstack-sdk-py/docs/templates/overview.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/overview.mdx.j2 new file mode 100644 index 0000000000..1136d8118b --- /dev/null +++ b/apps/agentstack-sdk-py/docs/templates/overview.mdx.j2 @@ -0,0 +1,25 @@ +--- +title: "Python SDK Reference" +description: "Complete reference for the Agent Stack Python SDK (agentstack-sdk)" +--- + +{{ autogen_warning }} + +The Agent Stack Python SDK (`agentstack-sdk`) provides the tools to build, run, and integrate +A2A-compatible agents with the Agent Stack platform. + +Install with: + +```bash +pip install agentstack-sdk +``` + +## Modules + + +{%- for mod in top_modules %} + + {{ mod.description }} + +{%- endfor %} + diff --git a/apps/agentstack-sdk-py/pyproject.toml b/apps/agentstack-sdk-py/pyproject.toml index 5d4fdf7242..20785b48f4 100644 --- a/apps/agentstack-sdk-py/pyproject.toml +++ b/apps/agentstack-sdk-py/pyproject.toml @@ -28,11 +28,14 @@ dependencies = [ "typing-extensions>=4.15.0", "opentelemetry-instrumentation-httpx>=0.60b1", "opentelemetry-instrumentation-openai>=0.52.3", + "mkgendocs>=0.9.2", ] [dependency-groups] dev = [ "beeai-framework[duckduckgo,wikipedia]>=0.1.76", + "griffe>=1.0.0", + "jinja2>=3.1.0", "pyrefly>=0.52.0", "pytest>=8.4.1", "pytest-asyncio>=1.1.0", diff --git a/apps/agentstack-sdk-py/src/agentstack_sdk/platform/client.py b/apps/agentstack-sdk-py/src/agentstack_sdk/platform/client.py index 168e75ac54..33c10aa5e3 100644 --- a/apps/agentstack-sdk-py/src/agentstack_sdk/platform/client.py +++ b/apps/agentstack-sdk-py/src/agentstack_sdk/platform/client.py @@ -101,6 +101,8 @@ async def __aexit__( await super().__aexit__(exc_type, exc_value, traceback) +get_platform_client: typing.Callable[[], PlatformClient] +set_platform_client: typing.Callable[..., contextlib.AbstractContextManager[PlatformClient]] get_platform_client, set_platform_client = resource_context(factory=PlatformClient, default_factory=PlatformClient) P = typing.ParamSpec("P") @@ -119,6 +121,7 @@ async def use_async_resource(*args: P.args, **kwargs: P.kwargs) -> AsyncIterator return use_async_resource +use_platform_client: typing.Callable[..., contextlib.AbstractAsyncContextManager[PlatformClient]] use_platform_client = wrap_context(set_platform_client) diff --git a/apps/agentstack-sdk-py/tasks.toml b/apps/agentstack-sdk-py/tasks.toml index c86e8b06ae..3f118748c3 100644 --- a/apps/agentstack-sdk-py/tasks.toml +++ b/apps/agentstack-sdk-py/tasks.toml @@ -54,6 +54,74 @@ run = """ uv run --python="${usage_python?}" pytest """ +# docs + +["agentstack-sdk-py:docs"] +description = "Generate Python SDK reference docs for Mintlify" +depends = ["agentstack-sdk-py:setup"] +dir = "{{config_root}}/apps/agentstack-sdk-py" +run = """ +#!/bin/bash +set -euo pipefail + +DOCS_ROOT="$(cd "../../docs" && pwd)" +SDK_DOCS_DIR="${DOCS_ROOT}/development/reference/python-sdk" + +# Temp locations created by mktemp (macOS-compatible) +TEMP_OLD_DOCS="$(mktemp -d)" +TEMP_JSON="$(mktemp)" + +cleanup_on_failure() { + local exit_code=$? + # Always attempt to remove the temp JSON manifest + rm -f "${TEMP_JSON}" || true + + if [ "${exit_code}" -ne 0 ]; then + echo "⚠ Doc generation failed (exit ${exit_code}) — restoring previous state..." + # Remove any partially generated output + rm -rf "${SDK_DOCS_DIR}" || true + # Restore the backed-up docs when the backup is non-empty + if [ -d "${TEMP_OLD_DOCS}" ] && [ "$(ls -A "${TEMP_OLD_DOCS}" 2>/dev/null)" ]; then + mkdir -p "${SDK_DOCS_DIR}" + mv "${TEMP_OLD_DOCS}/." "${SDK_DOCS_DIR}/" || true + fi + fi + + rm -rf "${TEMP_OLD_DOCS}" || true +} +trap cleanup_on_failure EXIT + +# Step 1: back up existing docs +if [ -d "${SDK_DOCS_DIR}" ]; then + echo "Backing up current docs → ${TEMP_OLD_DOCS}" + cp -r "${SDK_DOCS_DIR}/." "${TEMP_OLD_DOCS}/" +fi + +# Step 2: introspect exports → temp JSON +echo "Running introspect_exports.py..." +uv run python docs/introspect_exports.py \\ + --src-root src/agentstack_sdk \\ + --output "${TEMP_JSON}" + +# Step 3: generate MDX docs from temp JSON +echo "Running generate_docs.py..." +uv run python docs/generate_docs.py \\ + --json-file "${TEMP_JSON}" \\ + --docs-dir "${DOCS_ROOT}" \\ + --templates-dir "docs/templates" + +# Step 4: delete the introspect JSON +rm -f "${TEMP_JSON}" + +# Step 5: delete the old-docs backup +rm -rf "${TEMP_OLD_DOCS}" + +# All good — disarm the failure-cleanup trap +trap - EXIT + +echo "✓ Docs generated successfully" +""" + # build ["agentstack-sdk-py:build"] diff --git a/apps/agentstack-sdk-py/uv.lock b/apps/agentstack-sdk-py/uv.lock index 2a6968bfc7..d1ac59afbd 100644 --- a/apps/agentstack-sdk-py/uv.lock +++ b/apps/agentstack-sdk-py/uv.lock @@ -37,6 +37,7 @@ dependencies = [ { name = "httpx" }, { name = "janus" }, { name = "mcp" }, + { name = "mkgendocs" }, { name = "objprint" }, { name = "opentelemetry-api" }, { name = "opentelemetry-exporter-otlp-proto-http" }, @@ -54,6 +55,8 @@ dependencies = [ [package.dev-dependencies] dev = [ { name = "beeai-framework", extra = ["duckduckgo", "wikipedia"] }, + { name = "griffe" }, + { name = "jinja2" }, { name = "pyrefly" }, { name = "pytest" }, { name = "pytest-asyncio" }, @@ -73,6 +76,7 @@ requires-dist = [ { name = "httpx" }, { name = "janus", specifier = ">=2.0.0" }, { name = "mcp", specifier = ">=1.12.3" }, + { name = "mkgendocs", specifier = ">=0.9.2" }, { name = "objprint", specifier = ">=0.3.0" }, { name = "opentelemetry-api", specifier = ">=1.35.0" }, { name = "opentelemetry-exporter-otlp-proto-http", specifier = ">=1.35.0" }, @@ -90,6 +94,8 @@ requires-dist = [ [package.metadata.requires-dev] dev = [ { name = "beeai-framework", extras = ["duckduckgo", "wikipedia"], specifier = ">=0.1.76" }, + { name = "griffe", specifier = ">=1.0.0" }, + { name = "jinja2", specifier = ">=3.1.0" }, { name = "pyrefly", specifier = ">=0.52.0" }, { name = "pytest", specifier = ">=8.4.1" }, { name = "pytest-asyncio", specifier = ">=1.1.0" }, @@ -270,6 +276,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/5c/0a/a72d10ed65068e115044937873362e6e32fab1b7dce0046aeb224682c989/asgiref-3.11.1-py3-none-any.whl", hash = "sha256:e8667a091e69529631969fd45dc268fa79b99c92c5fcdda727757e52146ec133", size = 24345, upload-time = "2026-02-03T13:30:13.039Z" }, ] +[[package]] +name = "astor" +version = "0.8.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/5a/21/75b771132fee241dfe601d39ade629548a9626d1d39f333fde31bc46febe/astor-0.8.1.tar.gz", hash = "sha256:6a6effda93f4e1ce9f618779b2dd1d9d84f1e32812c23a29b3fff6fd7f63fa5e", size = 35090, upload-time = "2019-12-10T01:50:35.51Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c3/88/97eef84f48fa04fbd6750e62dcceafba6c63c81b7ac1420856c8dcc0a3f9/astor-0.8.1-py2.py3-none-any.whl", hash = "sha256:070a54e890cefb5b3739d19f30f5a5ec840ffc9c50ffa7d23cc9fc1a38ebbfc5", size = 27488, upload-time = "2019-12-10T01:50:33.628Z" }, +] + [[package]] name = "async-lru" version = "2.2.0" @@ -938,6 +953,38 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/c4/ab/09169d5a4612a5f92490806649ac8d41e3ec9129c636754575b3553f4ea4/googleapis_common_protos-1.72.0-py3-none-any.whl", hash = "sha256:4299c5a82d5ae1a9702ada957347726b167f9f8d1fc352477702a1e851ff4038", size = 297515, upload-time = "2025-11-06T18:29:13.14Z" }, ] +[[package]] +name = "griffe" +version = "2.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "griffecli" }, + { name = "griffelib" }, +] +wheels = [ + { url = "https://files.pythonhosted.org/packages/8b/94/ee21d41e7eb4f823b94603b9d40f86d3c7fde80eacc2c3c71845476dddaa/griffe-2.0.0-py3-none-any.whl", hash = "sha256:5418081135a391c3e6e757a7f3f156f1a1a746cc7b4023868ff7d5e2f9a980aa", size = 5214, upload-time = "2026-02-09T19:09:44.105Z" }, +] + +[[package]] +name = "griffecli" +version = "2.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama" }, + { name = "griffelib" }, +] +wheels = [ + { url = "https://files.pythonhosted.org/packages/e6/ed/d93f7a447bbf7a935d8868e9617cbe1cadf9ee9ee6bd275d3040fbf93d60/griffecli-2.0.0-py3-none-any.whl", hash = "sha256:9f7cd9ee9b21d55e91689358978d2385ae65c22f307a63fb3269acf3f21e643d", size = 9345, upload-time = "2026-02-09T19:09:42.554Z" }, +] + +[[package]] +name = "griffelib" +version = "2.0.0" +source = { registry = "https://pypi.org/simple" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/4d/51/c936033e16d12b627ea334aaaaf42229c37620d0f15593456ab69ab48161/griffelib-2.0.0-py3-none-any.whl", hash = "sha256:01284878c966508b6d6f1dbff9b6fa607bc062d8261c5c7253cb285b06422a7f", size = 142004, upload-time = "2026-02-09T19:09:40.561Z" }, +] + [[package]] name = "h11" version = "0.16.0" @@ -1383,6 +1430,18 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/6c/77/d7f491cbc05303ac6801651aabeb262d43f319288c1ea96c66b1d2692ff3/lxml-6.0.2-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:27220da5be049e936c3aca06f174e8827ca6445a4353a1995584311487fc4e3e", size = 3518768, upload-time = "2025-09-22T04:04:57.097Z" }, ] +[[package]] +name = "mako" +version = "1.3.10" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markupsafe" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/9e/38/bd5b78a920a64d708fe6bc8e0a2c075e1389d53bef8413725c63ba041535/mako-1.3.10.tar.gz", hash = "sha256:99579a6f39583fa7e5630a28c3c1f440e4e97a414b80372649c0ce338da2ea28", size = 392474, upload-time = "2025-04-10T12:44:31.16Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/87/fb/99f81ac72ae23375f22b7afdb7642aba97c00a713c217124420147681a2f/mako-1.3.10-py3-none-any.whl", hash = "sha256:baef24a52fc4fc514a0887ac600f9f1cff3d82c61d4d700a1fa84d597b88db59", size = 78509, upload-time = "2025-04-10T12:50:53.297Z" }, +] + [[package]] name = "markdown-it-py" version = "4.0.0" @@ -1503,6 +1562,21 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979, upload-time = "2022-08-14T12:40:09.779Z" }, ] +[[package]] +name = "mkgendocs" +version = "0.9.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "astor" }, + { name = "mako" }, + { name = "pyyaml" }, + { name = "six" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/fb/a0/9505f017d1fe5ca8cffb9849f49aebaa4255301d3bef517494d836608073/mkgendocs-0.9.2.tar.gz", hash = "sha256:556784e7d6830b1d9330ec8ca372b7db780eb1083f573b162cbd80f9f493c000", size = 16539, upload-time = "2022-08-11T23:58:40.895Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a3/dd/3cb20e728256026d5624d6601224ee418854da1a42c350990c51d03f62b4/mkgendocs-0.9.2-py3-none-any.whl", hash = "sha256:4ca8f695aca1741e5fe4728713598eba942447650bf2c84f2c27f33413f57417", size = 15718, upload-time = "2022-08-11T23:58:39.596Z" }, +] + [[package]] name = "multidict" version = "6.7.1" @@ -2641,6 +2715,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/e0/f9/0595336914c5619e5f28a1fb793285925a8cd4b432c9da0a987836c7f822/shellingham-1.5.4-py2.py3-none-any.whl", hash = "sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686", size = 9755, upload-time = "2023-10-24T04:13:38.866Z" }, ] +[[package]] +name = "six" +version = "1.17.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/94/e7/b2c673351809dca68a0e064b6af791aa332cf192da575fd474ed7d6f16a2/six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81", size = 34031, upload-time = "2024-12-04T17:35:28.174Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050, upload-time = "2024-12-04T17:35:26.475Z" }, +] + [[package]] name = "sniffio" version = "1.3.1" diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx new file mode 100644 index 0000000000..527092deda --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx @@ -0,0 +1,26 @@ +--- +title: "OAuth Storage" +description: "Storage backends for OAuth flow state" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorage, MemoryTokenStorageFactory, TokenStorageFactory +``` +--- +### Classes + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx new file mode 100644 index 0000000000..170f4e4cb2 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx @@ -0,0 +1,59 @@ +--- +title: "MemoryTokenStorage" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorage +```python +from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorage +``` +**Bases:** `TokenStorage` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `tokens` | `OAuthToken \| None` | `None` | +| `client_info` | `OAuthClientInformationFull \| None` | `None` | + +## Methods + + + + + + + +**Returns:** `OAuthToken | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `tokens` | `OAuthToken` | — | + +**Returns:** `None` + + + +**Returns:** `OAuthClientInformationFull | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client_info` | `OAuthClientInformationFull` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx new file mode 100644 index 0000000000..683c79e8fb --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx @@ -0,0 +1,34 @@ +--- +title: "MemoryTokenStorageFactory" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorageFactory +```python +from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorageFactory +``` +**Bases:** `TokenStorageFactory` +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client_info` | `OAuthClientInformationFull \| None` | — | + + + + +**Returns:** `TokenStorage` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx new file mode 100644 index 0000000000..80464a30d6 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx @@ -0,0 +1,27 @@ +--- +title: "TokenStorageFactory" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / TokenStorageFactory +```python +from agentstack_sdk.a2a.extensions.auth.oauth.storage import TokenStorageFactory +``` +**Bases:** `ABC` +## Methods + + + + + + +**Returns:** `TokenStorage` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth.mdx new file mode 100644 index 0000000000..2c7a718fac --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth.mdx @@ -0,0 +1,43 @@ +--- +title: "OAuth Extensions" +description: "OAuth 2.0 flow extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.auth.oauth import AuthRequest, AuthResponse, OAuthDemand # ... +``` + + + Storage backends for OAuth flow state + + +--- +### Classes + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx new file mode 100644 index 0000000000..bb3c833aa0 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx @@ -0,0 +1,22 @@ +--- +title: "AuthRequest" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthRequest +```python +from agentstack_sdk.a2a.extensions.auth.oauth import AuthRequest +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `authorization_endpoint_url` | `AnyUrl` | — | diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx new file mode 100644 index 0000000000..bcdad6a253 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx @@ -0,0 +1,22 @@ +--- +title: "AuthResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthResponse +```python +from agentstack_sdk.a2a.extensions.auth.oauth import AuthResponse +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `redirect_uri` | `AnyUrl` | — | diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx new file mode 100644 index 0000000000..edc351cff1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx @@ -0,0 +1,22 @@ +--- +title: "OAuthDemand" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthDemand +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthDemand +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `redirect_uri` | `bool` | `True` | diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx new file mode 100644 index 0000000000..f43f6994ae --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx @@ -0,0 +1,48 @@ +--- +title: "OAuthExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionClient +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionClient +``` +**Bases:** `BaseExtensionClient[OAuthExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `oauth_fulfillments` | `dict[str, Any]` | — | + +**Returns:** `dict[str, Any]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `task_id` | `str` | — | +| `redirect_uri` | `AnyUrl` | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx new file mode 100644 index 0000000000..5e4acd2ed5 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "OAuthExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `oauth_fulfillments` | `dict[str, OAuthFulfillment]` | `{}` | diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx new file mode 100644 index 0000000000..6a01bf6213 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "OAuthExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionParams +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `oauth_demands` | `dict[str, OAuthDemand]` | — | diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx new file mode 100644 index 0000000000..574c9623ef --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx @@ -0,0 +1,71 @@ +--- +title: "OAuthExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionServer +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionServer +``` +**Bases:** `BaseExtensionServer[OAuthExtensionSpec, OAuthExtensionMetadata]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context` | `RunContext` | — | +| `token_storage_factory` | `TokenStorageFactory` | `token_storage_factory or MemoryTokenStor...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `spec` | `OAuthExtensionSpec` | — | +| `token_storage_factory` | `TokenStorageFactory \| None` | — | + +**Returns:** `None` + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `resource_url` | `AnyUrl` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `authorization_endpoint_url` | `AnyUrl` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx new file mode 100644 index 0000000000..54a5e46058 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx @@ -0,0 +1,39 @@ +--- +title: "OAuthExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionSpec +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionSpec +``` +**Bases:** `BaseExtensionSpec[OAuthExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str` | `_DEFAULT_DEMAND_NAME` | + +**Returns:** `Self` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx new file mode 100644 index 0000000000..c1e7399f01 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx @@ -0,0 +1,22 @@ +--- +title: "OAuthFulfillment" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthFulfillment +```python +from agentstack_sdk.a2a.extensions.auth.oauth import OAuthFulfillment +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `redirect_uri` | `AnyUrl` | — | diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets.mdx new file mode 100644 index 0000000000..0a116a64b5 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets.mdx @@ -0,0 +1,40 @@ +--- +title: "Secrets Extensions" +description: "Secrets injection extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretDemand, SecretFulfillment, SecretsExtensionClient # ... +``` +--- +### Classes + + + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `A2A_EXTENSION_SECRETS_REQUESTED` | *constant* | — | +| `A2A_EXTENSION_SECRETS_RESOLVED` | *constant* | — | diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx new file mode 100644 index 0000000000..9d1a49f1f4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx @@ -0,0 +1,23 @@ +--- +title: "SecretDemand" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretDemand +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretDemand +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | — | +| `description` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx new file mode 100644 index 0000000000..e1f18e3d39 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx @@ -0,0 +1,22 @@ +--- +title: "SecretFulfillment" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretFulfillment +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretFulfillment +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `secret` | `SecretStr` | — | diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx new file mode 100644 index 0000000000..b87a58f147 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "SecretsExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionClient +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionClient +``` +**Bases:** `BaseExtensionClient[SecretsExtensionSpec, SecretsServiceExtensionParams]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx new file mode 100644 index 0000000000..6d8d444fa3 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx @@ -0,0 +1,58 @@ +--- +title: "SecretsExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionServer +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionServer +``` +**Bases:** `BaseExtensionServer[SecretsExtensionSpec, SecretsServiceExtensionMetadata]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context` | `RunContext` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + +**Returns:** `SecretsServiceExtensionMetadata` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `params` | `SecretsServiceExtensionParams` | — | + +**Returns:** `SecretsServiceExtensionMetadata` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx new file mode 100644 index 0000000000..36d534d94a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx @@ -0,0 +1,41 @@ +--- +title: "SecretsExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionSpec +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionSpec +``` +**Bases:** `BaseExtensionSpec[SecretsServiceExtensionParams | None]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str` | — | +| `key` | `str \| None` | — | +| `description` | `str \| None` | — | + +**Returns:** `Self` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx new file mode 100644 index 0000000000..8416261739 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "SecretsServiceExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretsServiceExtensionMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `secret_fulfillments` | `dict[str, SecretFulfillment]` | `{}` | diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx new file mode 100644 index 0000000000..d792e1283c --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "SecretsServiceExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionParams +```python +from agentstack_sdk.a2a.extensions.auth.secrets import SecretsServiceExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `secret_demands` | `dict[str, SecretDemand]` | — | diff --git a/docs/development/reference/python-sdk/a2a-auth.mdx b/docs/development/reference/python-sdk/a2a-auth.mdx new file mode 100644 index 0000000000..45819937ce --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-auth.mdx @@ -0,0 +1,20 @@ +--- +title: "Auth Extensions" +description: "OAuth and secrets authentication extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} + + + OAuth 2.0 flow extensions + + + Secrets injection extensions + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common.mdx b/docs/development/reference/python-sdk/a2a-common.mdx new file mode 100644 index 0000000000..918cf6b48d --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common.mdx @@ -0,0 +1,78 @@ +--- +title: "Common Types" +description: "Shared base classes and form types for extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.common import BaseField, BaseFormRender, BaseFormResponse # ... +``` +--- +### Classes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `FormField` | *union_alias* | `TextField \| DateField \| FileField \| SingleSelectField \| MultiSelectField \| CheckboxField \| CheckboxGroupField` | +| `FormFieldValue` | *union_alias* | `TextFieldValue \| DateFieldValue \| FileFieldValue \| SingleSelectFieldValue \| MultiSelectFieldValue \| CheckboxFieldValue \| CheckboxGroupFieldValue` | +| `IterValue` | *union_alias* | `list[dict[str, str \| None]] \| NonFileIterValue` | +| `NonFileIterValue` | *union_alias* | `dict[str, bool \| None] \| list[str] \| str \| bool \| None` | +| `SettingsFormField` | *union_alias* | `CheckboxGroupField \| SingleSelectField` | +| `SettingsFormFieldValue` | *union_alias* | `CheckboxGroupFieldValue \| SingleSelectFieldValue` | diff --git a/docs/development/reference/python-sdk/a2a-common/BaseField.mdx b/docs/development/reference/python-sdk/a2a-common/BaseField.mdx new file mode 100644 index 0000000000..666ce72a77 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/BaseField.mdx @@ -0,0 +1,25 @@ +--- +title: "BaseField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / BaseField +```python +from agentstack_sdk.a2a.extensions.common import BaseField +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `label` | `str` | — | +| `required` | `bool` | `False` | +| `col_span` | `int \| None` | `Field(default=None, ge=1, le=4)` | diff --git a/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx b/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx new file mode 100644 index 0000000000..3433f2c158 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx @@ -0,0 +1,26 @@ +--- +title: "BaseFormRender" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / BaseFormRender +```python +from agentstack_sdk.a2a.extensions.common import BaseFormRender +``` +**Bases:** `BaseModel , Generic[F]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `title` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | +| `columns` | `int \| None` | `Field(default=None, ge=1, le=4)` | +| `submit_label` | `str \| None` | `None` | +| `fields` | `list[F]` | — | diff --git a/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx b/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx new file mode 100644 index 0000000000..79baf5cc14 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx @@ -0,0 +1,22 @@ +--- +title: "BaseFormResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / BaseFormResponse +```python +from agentstack_sdk.a2a.extensions.common import BaseFormResponse +``` +**Bases:** `BaseModel , Generic[FV]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `values` | `dict[str, FV]` | — | diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx new file mode 100644 index 0000000000..b4111cb93c --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx @@ -0,0 +1,24 @@ +--- +title: "CheckboxField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxField +```python +from agentstack_sdk.a2a.extensions.common import CheckboxField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['checkbox']` | `'checkbox'` | +| `content` | `str` | — | +| `default_value` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx new file mode 100644 index 0000000000..42abcf47bb --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "CheckboxFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxFieldValue +```python +from agentstack_sdk.a2a.extensions.common import CheckboxFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['checkbox']` | `'checkbox'` | +| `value` | `bool \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx new file mode 100644 index 0000000000..2fa4e56444 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx @@ -0,0 +1,23 @@ +--- +title: "CheckboxGroupField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxGroupField +```python +from agentstack_sdk.a2a.extensions.common import CheckboxGroupField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['checkbox_group']` | `'checkbox_group'` | +| `fields` | `list[CheckboxField]` | — | diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx new file mode 100644 index 0000000000..2fb2aad609 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "CheckboxGroupFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxGroupFieldValue +```python +from agentstack_sdk.a2a.extensions.common import CheckboxGroupFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['checkbox_group']` | `'checkbox_group'` | +| `value` | `dict[str, bool \| None] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/DateField.mdx b/docs/development/reference/python-sdk/a2a-common/DateField.mdx new file mode 100644 index 0000000000..7129af67de --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/DateField.mdx @@ -0,0 +1,24 @@ +--- +title: "DateField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / DateField +```python +from agentstack_sdk.a2a.extensions.common import DateField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['date']` | `'date'` | +| `placeholder` | `str \| None` | `None` | +| `default_value` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx new file mode 100644 index 0000000000..8ea8393fdc --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "DateFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / DateFieldValue +```python +from agentstack_sdk.a2a.extensions.common import DateFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['date']` | `'date'` | +| `value` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/FileField.mdx b/docs/development/reference/python-sdk/a2a-common/FileField.mdx new file mode 100644 index 0000000000..cc447a93c0 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/FileField.mdx @@ -0,0 +1,23 @@ +--- +title: "FileField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileField +```python +from agentstack_sdk.a2a.extensions.common import FileField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['file']` | `'file'` | +| `accept` | `list[str]` | — | diff --git a/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx new file mode 100644 index 0000000000..165b2449eb --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "FileFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileFieldValue +```python +from agentstack_sdk.a2a.extensions.common import FileFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['file']` | `'file'` | +| `value` | `list[FileInfo] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx b/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx new file mode 100644 index 0000000000..ad50c3dcf4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx @@ -0,0 +1,24 @@ +--- +title: "FileInfo" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileInfo +```python +from agentstack_sdk.a2a.extensions.common import FileInfo +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `uri` | `str` | — | +| `name` | `str \| None` | `None` | +| `mime_type` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/FileItem.mdx b/docs/development/reference/python-sdk/a2a-common/FileItem.mdx new file mode 100644 index 0000000000..2766a613c5 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/FileItem.mdx @@ -0,0 +1,24 @@ +--- +title: "FileItem" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileItem +```python +from agentstack_sdk.a2a.extensions.common import FileItem +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `uri` | `str` | — | +| `name` | `str \| None` | `None` | +| `mime_type` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/FormRender.mdx b/docs/development/reference/python-sdk/a2a-common/FormRender.mdx new file mode 100644 index 0000000000..e86eaaec45 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/FormRender.mdx @@ -0,0 +1,17 @@ +--- +title: "FormRender" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FormRender +```python +from agentstack_sdk.a2a.extensions.common import FormRender +``` +**Bases:** `BaseFormRender[FormField]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx b/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx new file mode 100644 index 0000000000..8320a5a5c8 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx @@ -0,0 +1,17 @@ +--- +title: "FormResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FormResponse +```python +from agentstack_sdk.a2a.extensions.common import FormResponse +``` +**Bases:** `BaseFormResponse[FormFieldValue]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx b/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx new file mode 100644 index 0000000000..8bf1cda2d6 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx @@ -0,0 +1,32 @@ +--- +title: "MultiSelectField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / MultiSelectField +```python +from agentstack_sdk.a2a.extensions.common import MultiSelectField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['multiselect']` | `'multiselect'` | +| `options` | `list[OptionItem]` | — | +| `default_value` | `list[str] \| None` | `None` | + +## Methods + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx new file mode 100644 index 0000000000..1204ae3044 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "MultiSelectFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / MultiSelectFieldValue +```python +from agentstack_sdk.a2a.extensions.common import MultiSelectFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['multiselect']` | `'multiselect'` | +| `value` | `list[str] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx b/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx new file mode 100644 index 0000000000..8e43bf4265 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx @@ -0,0 +1,23 @@ +--- +title: "OptionItem" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / OptionItem +```python +from agentstack_sdk.a2a.extensions.common import OptionItem +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `label` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx b/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx new file mode 100644 index 0000000000..daeebf676d --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx @@ -0,0 +1,17 @@ +--- +title: "SettingsFormRender" +description: "FormRender for settings - only allows fields defined in SettingsFormField" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SettingsFormRender +```python +from agentstack_sdk.a2a.extensions.common import SettingsFormRender +``` +**Bases:** `BaseFormRender[SettingsFormField]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx b/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx new file mode 100644 index 0000000000..2d82178e6a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx @@ -0,0 +1,17 @@ +--- +title: "SettingsFormResponse" +description: "FormResponse for settings - only allows fields defined in SettingsFormFieldValue" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SettingsFormResponse +```python +from agentstack_sdk.a2a.extensions.common import SettingsFormResponse +``` +**Bases:** `BaseFormResponse[SettingsFormFieldValue]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx b/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx new file mode 100644 index 0000000000..98633fd023 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx @@ -0,0 +1,32 @@ +--- +title: "SingleSelectField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SingleSelectField +```python +from agentstack_sdk.a2a.extensions.common import SingleSelectField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['singleselect']` | `'singleselect'` | +| `options` | `list[OptionItem]` | — | +| `default_value` | `str \| None` | `None` | + +## Methods + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx new file mode 100644 index 0000000000..e5d01a2cfb --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "SingleSelectFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SingleSelectFieldValue +```python +from agentstack_sdk.a2a.extensions.common import SingleSelectFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['singleselect']` | `'singleselect'` | +| `value` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-common/TextField.mdx b/docs/development/reference/python-sdk/a2a-common/TextField.mdx new file mode 100644 index 0000000000..466d9335b9 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/TextField.mdx @@ -0,0 +1,25 @@ +--- +title: "TextField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / TextField +```python +from agentstack_sdk.a2a.extensions.common import TextField +``` +**Bases:** `BaseField` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['text']` | `'text'` | +| `placeholder` | `str \| None` | `None` | +| `default_value` | `str \| None` | `None` | +| `auto_resize` | `bool \| None` | `True` | diff --git a/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx new file mode 100644 index 0000000000..ebe907f43a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "TextFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / TextFieldValue +```python +from agentstack_sdk.a2a.extensions.common import TextFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['text']` | `'text'` | +| `value` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx new file mode 100644 index 0000000000..6124ce4c12 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx @@ -0,0 +1,50 @@ +--- +title: "BaseExtensionClient" +description: "Type of the extension metadata, attached to messages" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / BaseExtensionClient +```python +from agentstack_sdk.a2a.extensions.base import BaseExtensionClient +``` +**Bases:** `ABC , typing.Generic[ExtensionSpecT, MetadataFromServerT]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `spec` | — | `spec` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `spec` | `ExtensionSpecT` | — | + +**Returns:** `None` + + + + + +Client should use this method to retrieve extension-associated metadata from a message. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + +**Returns:** `MetadataFromServerT | None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx new file mode 100644 index 0000000000..05acad1c30 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx @@ -0,0 +1,67 @@ +--- +title: "BaseExtensionServer" +description: "Type of the extension metadata, attached to messages" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / BaseExtensionServer +```python +from agentstack_sdk.a2a.extensions.base import BaseExtensionServer +``` +**Bases:** `ABC , typing.Generic[ExtensionSpecT, MetadataFromClientT]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `data` | — | — | +| `spec` | — | `spec` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `spec` | `ExtensionSpecT` | — | +| `args` | — | `()` | +| `kwargs` | — | `{}` | + +**Returns:** `None` + + + + + +Server should use this method to retrieve extension-associated metadata from a message. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + +**Returns:** `MetadataFromClientT | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +Called when entering the agent context after the first message was parsed (__call__ was already called) +**Returns:** `AsyncIterator[None]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx new file mode 100644 index 0000000000..23c34842b7 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx @@ -0,0 +1,69 @@ +--- +title: "BaseExtensionSpec" +description: "Base class for an A2A extension handler" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / BaseExtensionSpec +```python +from agentstack_sdk.a2a.extensions.base import BaseExtensionSpec +``` +**Bases:** `ABC , typing.Generic[ParamsT]` +The base implementations assume a single URI. More complex extension +handlers (e.g. serving multiple versions of an extension spec) may override +the appropriate methods. +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | — | +| `DESCRIPTION` | `str \| None` | `None` | +| `params` | `ParamsT` | `params` | + +## Methods + + + + +Agent should construct an extension instance using the constructor. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `params` | `ParamsT` | — | + +**Returns:** `None` + + + + + +Client should construct an extension instance using this classmethod. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent` | `AgentCard` | — | + +**Returns:** `Self | None` + + + +Agent should use this method to obtain extension definitions to advertise on the agent card. +This returns a list, as it's possible to support multiple A2A extensions within a single class. +(Usually, that would be different versions of the extension spec.) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `required` | `bool` | `False` | + +**Returns:** `list[AgentExtension]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx new file mode 100644 index 0000000000..60ec41539d --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx @@ -0,0 +1,34 @@ +--- +title: "NoParamsBaseExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / NoParamsBaseExtensionSpec +```python +from agentstack_sdk.a2a.extensions.base import NoParamsBaseExtensionSpec +``` +**Bases:** `BaseExtensionSpec[NoneType]` +## Methods + + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent` | `AgentCard` | — | + +**Returns:** `Self | None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx b/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx new file mode 100644 index 0000000000..7f1203dabd --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx @@ -0,0 +1,37 @@ +--- +title: "ExtensionError" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Exceptions](/development/reference/python-sdk/a2a-extensions-exceptions) / ExtensionError +```python +from agentstack_sdk.a2a.extensions.exceptions import ExtensionError +``` +**Bases:** `Exception` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `extension` | `BaseExtensionSpec` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `spec` | `BaseExtensionSpec` | — | +| `message` | `str` | — | + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions.mdx b/docs/development/reference/python-sdk/a2a-interactions.mdx new file mode 100644 index 0000000000..f967959d77 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions.mdx @@ -0,0 +1,47 @@ +--- +title: "Interaction Extensions" +description: "Human-in-the-loop interaction extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionClient, ApprovalExtensionMetadata, ApprovalExtensionParams # ... +``` +--- +### Classes + + + + + + + + + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `A2A_EXTENSION_APPROVAL_REQUESTED` | *constant* | — | +| `A2A_EXTENSION_APPROVAL_RESOLVED` | *constant* | — | +| `ApprovalRequest` | *special_form* | `Annotated[GenericApprovalRequest \| ToolCallApprovalRequest, Discriminator('action')]` | diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx new file mode 100644 index 0000000000..f05dd86e1b --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx @@ -0,0 +1,42 @@ +--- +title: "ApprovalExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionClient +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionClient +``` +**Bases:** `BaseExtensionClient[ApprovalExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `response` | `ApprovalResponse` | — | +| `task_id` | `str \| None` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `Message` | — | + + +**Returns:** `dict[str, Any]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx new file mode 100644 index 0000000000..8e9ecbf45e --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx @@ -0,0 +1,17 @@ +--- +title: "ApprovalExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionMetadata +``` +**Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx new file mode 100644 index 0000000000..5a6895d554 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx @@ -0,0 +1,17 @@ +--- +title: "ApprovalExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionParams +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionParams +``` +**Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx new file mode 100644 index 0000000000..a27cee2862 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx @@ -0,0 +1,48 @@ +--- +title: "ApprovalExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionServer +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionServer +``` +**Bases:** `BaseExtensionServer[ApprovalExtensionSpec, ApprovalExtensionMetadata]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request` | `ApprovalRequest` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `Message` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request` | `ApprovalRequest` | — | +| `context` | `RunContext` | — | + +**Returns:** `ApprovalResponse` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx new file mode 100644 index 0000000000..9c5742a7f9 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "ApprovalExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionSpec +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionSpec +``` +**Bases:** `BaseExtensionSpec[ApprovalExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx new file mode 100644 index 0000000000..4552ebf3e5 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx @@ -0,0 +1,17 @@ +--- +title: "ApprovalRejectionError" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalRejectionError +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalRejectionError +``` +**Bases:** `RuntimeError` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx new file mode 100644 index 0000000000..1cb0e3a399 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx @@ -0,0 +1,34 @@ +--- +title: "ApprovalResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalResponse +```python +from agentstack_sdk.a2a.extensions.interactions import ApprovalResponse +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `decision` | `Literal['approve', 'reject']` | — | +| `approved` | `bool` | — | + +## Methods + + + + + + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx b/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx new file mode 100644 index 0000000000..f989629f46 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx @@ -0,0 +1,24 @@ +--- +title: "GenericApprovalRequest" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / GenericApprovalRequest +```python +from agentstack_sdk.a2a.extensions.interactions import GenericApprovalRequest +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `action` | `Literal['generic']` | `'generic'` | +| `title` | `str \| None` | `Field(None, description='A human-readabl...` | +| `description` | `str \| None` | `Field(None, description='A human-readabl...` | diff --git a/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx b/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx new file mode 100644 index 0000000000..4bed7712de --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx @@ -0,0 +1,46 @@ +--- +title: "ToolCallApprovalRequest" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ToolCallApprovalRequest +```python +from agentstack_sdk.a2a.extensions.interactions import ToolCallApprovalRequest +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `action` | `Literal['tool-call']` | `'tool-call'` | +| `title` | `str \| None` | `Field(None, description='A human-readabl...` | +| `description` | `str \| None` | `Field(None, description='A human-readabl...` | +| `name` | `str` | `Field(description='The programmatic name...` | +| `input` | `dict[str, Any] \| None` | `Field(description='The input for the too...` | +| `server` | `ToolCallServer \| None` | `Field(None, description='The server exec...` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `tool` | `Tool` | — | +| `input` | `dict[str, Any] \| None` | — | +| `server` | `Implementation \| None` | — | + +**Returns:** `'ToolCallApprovalRequest'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx b/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx new file mode 100644 index 0000000000..ceca2c6416 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx @@ -0,0 +1,24 @@ +--- +title: "ToolCallServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ToolCallServer +```python +from agentstack_sdk.a2a.extensions.interactions import ToolCallServer +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | `Field(description='The programmatic name...` | +| `title` | `str \| None` | `Field(description='A human-readable titl...` | +| `version` | `str` | `Field(description='The version of the se...` | diff --git a/docs/development/reference/python-sdk/a2a-services.mdx b/docs/development/reference/python-sdk/a2a-services.mdx new file mode 100644 index 0000000000..f471422b2e --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services.mdx @@ -0,0 +1,95 @@ +--- +title: "Service Extensions" +description: "LLM, embedding, MCP, and platform service extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingDemand, EmbeddingFulfillment, EmbeddingServiceExtensionClient # ... +``` +--- +### Classes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `MCPTransport` | *special_form* | `Annotated[StdioTransport \| StreamableHTTPTransport, pydantic.Field(discriminator='type')]` | diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx new file mode 100644 index 0000000000..a40728d027 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx @@ -0,0 +1,23 @@ +--- +title: "EmbeddingDemand" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingDemand +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingDemand +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `description` | `str \| None` | `None` | +| `suggested` | `tuple[str, ...]` | `()` | diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx new file mode 100644 index 0000000000..f66bdb5391 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx @@ -0,0 +1,25 @@ +--- +title: "EmbeddingFulfillment" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingFulfillment +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingFulfillment +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `identifier` | `str \| None` | `None` | +| `api_base` | `str` | — | +| `api_key` | `str` | — | +| `api_model` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx new file mode 100644 index 0000000000..89abf799c0 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx @@ -0,0 +1,33 @@ +--- +title: "EmbeddingServiceExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionClient +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionClient +``` +**Bases:** `BaseExtensionClient[EmbeddingServiceExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `embedding_fulfillments` | `dict[str, EmbeddingFulfillment]` | — | + +**Returns:** `dict[str, Any]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx new file mode 100644 index 0000000000..99d2fa495a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "EmbeddingServiceExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `embedding_fulfillments` | `dict[str, EmbeddingFulfillment]` | `{}` | diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx new file mode 100644 index 0000000000..1cb7c66408 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "EmbeddingServiceExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionParams +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `embedding_demands` | `dict[str, EmbeddingDemand]` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx new file mode 100644 index 0000000000..9c05b52f8f --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx @@ -0,0 +1,32 @@ +--- +title: "EmbeddingServiceExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionServer +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionServer +``` +**Bases:** `BaseExtensionServer[EmbeddingServiceExtensionSpec, EmbeddingServiceExtensionMetadata]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx new file mode 100644 index 0000000000..a1ce423d5c --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx @@ -0,0 +1,41 @@ +--- +title: "EmbeddingServiceExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionSpec +```python +from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionSpec +``` +**Bases:** `BaseExtensionSpec[EmbeddingServiceExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str \| None` | — | +| `description` | `str \| None` | — | +| `suggested` | `tuple[str, ...]` | `()` | + +**Returns:** `Self` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx b/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx new file mode 100644 index 0000000000..310d57a7fe --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx @@ -0,0 +1,23 @@ +--- +title: "FormDemands" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormDemands +```python +from agentstack_sdk.a2a.extensions.services import FormDemands +``` +**Bases:** `TypedDict` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `initial_form` | `FormRender \| None` | — | +| `settings_form` | `SettingsFormRender \| None` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx new file mode 100644 index 0000000000..b2345096f4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx @@ -0,0 +1,33 @@ +--- +title: "FormServiceExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionClient +```python +from agentstack_sdk.a2a.extensions.services import FormServiceExtensionClient +``` +**Bases:** `BaseExtensionClient[FormServiceExtensionSpec, FormRender]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `form_fulfillments` | `dict[str, FormResponse \| SettingsFormResponse]` | — | + +**Returns:** `dict[str, Any]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx new file mode 100644 index 0000000000..0dad181ec7 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "FormServiceExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.services import FormServiceExtensionMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `form_fulfillments` | `dict[str, FormResponse \| SettingsFormResponse]` | `{}` | diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx new file mode 100644 index 0000000000..dc83746a1e --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "FormServiceExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionParams +```python +from agentstack_sdk.a2a.extensions.services import FormServiceExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `form_demands` | `FormDemands` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx new file mode 100644 index 0000000000..d1bc3563b4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx @@ -0,0 +1,48 @@ +--- +title: "FormServiceExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionServer +```python +from agentstack_sdk.a2a.extensions.services import FormServiceExtensionServer +``` +**Bases:** `BaseExtensionServer[FormServiceExtensionSpec, FormServiceExtensionMetadata]` +## Methods + + + + + + +Parse initial_form from form_fulfillments. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `model` | `type[T] \| None` | — | + +**Returns:** `T | FormResponse | None` + + + +Parse settings_form from form_fulfillments. + +This is the preferred way to access settings in agents, replacing the +deprecated SettingsExtensionServer.parse_settings_response(). +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `model` | `type[T] \| None` | — | + +**Returns:** `T | SettingsFormResponse | None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx new file mode 100644 index 0000000000..60b32e5d8f --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx @@ -0,0 +1,65 @@ +--- +title: "FormServiceExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionSpec +```python +from agentstack_sdk.a2a.extensions.services import FormServiceExtensionSpec +``` +**Bases:** `BaseExtensionSpec[FormServiceExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +Create form extension demanding an initial_form. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `initial_form` | `FormRender \| None` | — | + +**Returns:** `Self` + + + +Create form extension demanding a settings_form. + +This is the preferred way to add settings to an agent, replacing the deprecated SettingsExtensionSpec. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `settings_form` | `SettingsFormRender` | — | + +**Returns:** `Self` + + + +Create form extension demanding both initial_form and settings_form. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `initial_form` | `FormRender \| None` | — | +| `settings_form` | `SettingsFormRender \| None` | — | + +**Returns:** `Self` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx b/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx new file mode 100644 index 0000000000..0e1b2940be --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx @@ -0,0 +1,23 @@ +--- +title: "LLMDemand" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMDemand +```python +from agentstack_sdk.a2a.extensions.services import LLMDemand +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `description` | `str \| None` | `None` | +| `suggested` | `tuple[str, ...]` | `()` | diff --git a/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx b/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx new file mode 100644 index 0000000000..a6c28fe8f7 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx @@ -0,0 +1,25 @@ +--- +title: "LLMFulfillment" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMFulfillment +```python +from agentstack_sdk.a2a.extensions.services import LLMFulfillment +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `identifier` | `str \| None` | `None` | +| `api_base` | `str` | — | +| `api_key` | `str` | — | +| `api_model` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx new file mode 100644 index 0000000000..577d7d8dc1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx @@ -0,0 +1,33 @@ +--- +title: "LLMServiceExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionClient +```python +from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionClient +``` +**Bases:** `BaseExtensionClient[LLMServiceExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `llm_fulfillments` | `dict[str, LLMFulfillment]` | — | + +**Returns:** `dict[str, Any]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx new file mode 100644 index 0000000000..853366fa22 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "LLMServiceExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `llm_fulfillments` | `dict[str, LLMFulfillment]` | `{}` | diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx new file mode 100644 index 0000000000..062b4f9084 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "LLMServiceExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionParams +```python +from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `llm_demands` | `dict[str, LLMDemand]` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx new file mode 100644 index 0000000000..9bc36b7950 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx @@ -0,0 +1,32 @@ +--- +title: "LLMServiceExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionServer +```python +from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionServer +``` +**Bases:** `BaseExtensionServer[LLMServiceExtensionSpec, LLMServiceExtensionMetadata]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx new file mode 100644 index 0000000000..8ae34fc323 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx @@ -0,0 +1,41 @@ +--- +title: "LLMServiceExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionSpec +```python +from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionSpec +``` +**Bases:** `BaseExtensionSpec[LLMServiceExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str \| None` | — | +| `description` | `str \| None` | — | +| `suggested` | `tuple[str, ...]` | `()` | + +**Returns:** `Self` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx b/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx new file mode 100644 index 0000000000..c058bdf251 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx @@ -0,0 +1,24 @@ +--- +title: "MCPDemand" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPDemand +```python +from agentstack_sdk.a2a.extensions.services import MCPDemand +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `description` | `str \| None` | `None` | +| `suggested` | `tuple[str, ...]` | `()` | +| `allowed_transports` | `list[_TRANSPORT_TYPES]` | `pydantic.Field(default_factory=(lambda: ...` | diff --git a/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx b/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx new file mode 100644 index 0000000000..0292a4f88b --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx @@ -0,0 +1,22 @@ +--- +title: "MCPFulfillment" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPFulfillment +```python +from agentstack_sdk.a2a.extensions.services import MCPFulfillment +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `transport` | `MCPTransport` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx new file mode 100644 index 0000000000..c368950879 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx @@ -0,0 +1,33 @@ +--- +title: "MCPServiceExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionClient +```python +from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionClient +``` +**Bases:** `BaseExtensionClient[MCPServiceExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `mcp_fulfillments` | `dict[str, MCPFulfillment]` | — | + +**Returns:** `dict[str, Any]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx new file mode 100644 index 0000000000..0173790653 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "MCPServiceExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `mcp_fulfillments` | `dict[str, MCPFulfillment]` | `{}` | diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx new file mode 100644 index 0000000000..b9b6b5850a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "MCPServiceExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionParams +```python +from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `mcp_demands` | `dict[str, MCPDemand]` | — | diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx new file mode 100644 index 0000000000..a6a536ec6a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx @@ -0,0 +1,49 @@ +--- +title: "MCPServiceExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionServer +```python +from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionServer +``` +**Bases:** `BaseExtensionServer[MCPServiceExtensionSpec, MCPServiceExtensionMetadata]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + +**Returns:** `MCPServiceExtensionMetadata | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `demand` | `str` | `_DEFAULT_DEMAND_NAME` | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx new file mode 100644 index 0000000000..537488c8ec --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx @@ -0,0 +1,42 @@ +--- +title: "MCPServiceExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionSpec +```python +from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionSpec +``` +**Bases:** `BaseExtensionSpec[MCPServiceExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str` | `_DEFAULT_DEMAND_NAME` | +| `description` | `str \| None` | — | +| `suggested` | `tuple[str, ...]` | `()` | +| `allowed_transports` | `list[_TRANSPORT_TYPES] \| None` | — | + +**Returns:** `Self` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx new file mode 100644 index 0000000000..97d879bcc0 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx @@ -0,0 +1,17 @@ +--- +title: "PlatformApiExtension" +description: "Request authentication token and url to be able to access the agentstack API" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtension +```python +from agentstack_sdk.a2a.extensions.services import PlatformApiExtension +``` +**Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx new file mode 100644 index 0000000000..dd164cab9f --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx @@ -0,0 +1,35 @@ +--- +title: "PlatformApiExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionClient +```python +from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionClient +``` +**Bases:** `BaseExtensionClient[PlatformApiExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `auth_token` | `Secret[str] \| str` | — | +| `expires_at` | `AwareDatetime \| None` | — | +| `base_url` | `HttpUrl \| None` | — | + +**Returns:** `dict[str, dict[str, str]]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx new file mode 100644 index 0000000000..755cd225d4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx @@ -0,0 +1,24 @@ +--- +title: "PlatformApiExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionMetadata +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `base_url` | `HttpUrl \| None` | `None` | +| `auth_token` | `SecretStr \| None` | `None` | +| `expires_at` | `AwareDatetime \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx new file mode 100644 index 0000000000..450221b0dc --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx @@ -0,0 +1,22 @@ +--- +title: "PlatformApiExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionParams +```python +from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionParams +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `auto_use` | `bool` | `True` | diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx new file mode 100644 index 0000000000..7cf372f6f3 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx @@ -0,0 +1,51 @@ +--- +title: "PlatformApiExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionServer +```python +from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionServer +``` +**Bases:** `BaseExtensionServer[PlatformApiExtensionSpec, PlatformApiExtensionMetadata]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context_id` | `str \| None` | `None` | + +## Methods + + + + + + +Called when entering the agent context after the first message was parsed (__call__ was already called) +**Returns:** `AsyncIterator[None]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +**Returns:** `AsyncIterator[PlatformClient]` + + + +**Returns:** `BearerAuth` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx new file mode 100644 index 0000000000..f4d6698f5c --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx @@ -0,0 +1,39 @@ +--- +title: "PlatformApiExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionSpec +```python +from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionSpec +``` +**Bases:** `BaseExtensionSpec[PlatformApiExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `params` | `PlatformApiExtensionParams \| None` | — | + +**Returns:** `None` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx b/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx new file mode 100644 index 0000000000..b17e8683f1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx @@ -0,0 +1,25 @@ +--- +title: "StdioTransport" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / StdioTransport +```python +from agentstack_sdk.a2a.extensions.services import StdioTransport +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['stdio']` | `'stdio'` | +| `command` | `str` | — | +| `args` | `list[str]` | — | +| `env` | `dict[str, str] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx b/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx new file mode 100644 index 0000000000..bb83a42782 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx @@ -0,0 +1,24 @@ +--- +title: "StreamableHTTPTransport" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / StreamableHTTPTransport +```python +from agentstack_sdk.a2a.extensions.services import StreamableHTTPTransport +``` +**Bases:** `SecureBaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['streamable_http']` | `'streamable_http'` | +| `url` | `AnyUrl` | — | +| `headers` | `dict[str, str] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-tools.mdx b/docs/development/reference/python-sdk/a2a-tools.mdx new file mode 100644 index 0000000000..084b9208ee --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools.mdx @@ -0,0 +1,38 @@ +--- +title: "Tool Extensions" +description: "Tool call approval extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionClient, ToolCallExtensionMetadata, ToolCallExtensionParams # ... +``` +--- +### Classes + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx new file mode 100644 index 0000000000..25cb41dfea --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx @@ -0,0 +1,42 @@ +--- +title: "ToolCallExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionClient +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionClient +``` +**Bases:** `BaseExtensionClient[ToolCallExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `response` | `ToolCallResponse` | — | +| `task_id` | `str \| None` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `Message` | — | + + +**Returns:** `dict[str, Any]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx new file mode 100644 index 0000000000..4fc864b5a1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx @@ -0,0 +1,17 @@ +--- +title: "ToolCallExtensionMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionMetadata +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionMetadata +``` +**Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx new file mode 100644 index 0000000000..fd23d476e4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx @@ -0,0 +1,17 @@ +--- +title: "ToolCallExtensionParams" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionParams +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionParams +``` +**Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx new file mode 100644 index 0000000000..7542f6ed03 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx @@ -0,0 +1,48 @@ +--- +title: "ToolCallExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionServer +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionServer +``` +**Bases:** `BaseExtensionServer[ToolCallExtensionSpec, ToolCallExtensionMetadata]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request` | `ToolCallRequest` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `Message` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request` | `ToolCallRequest` | — | +| `context` | `RunContext` | — | + +**Returns:** `ToolCallResponse` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx new file mode 100644 index 0000000000..d41c65eb01 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "ToolCallExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionSpec +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionSpec +``` +**Bases:** `BaseExtensionSpec[ToolCallExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx new file mode 100644 index 0000000000..03abdaeda4 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx @@ -0,0 +1,17 @@ +--- +title: "ToolCallRejectionError" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallRejectionError +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallRejectionError +``` +**Bases:** `RuntimeError` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx new file mode 100644 index 0000000000..435ddef4d1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx @@ -0,0 +1,45 @@ +--- +title: "ToolCallRequest" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallRequest +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallRequest +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | `Field(description='The programmatic name...` | +| `title` | `str \| None` | `Field(None, description='A human-readabl...` | +| `description` | `str \| None` | `Field(None, description='A human-readabl...` | +| `input` | `dict[str, Any] \| None` | `Field(description='The input for the too...` | +| `server` | `ToolCallServer \| None` | `Field(None, description='The server exec...` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `tool` | `Tool` | — | +| `input` | `dict[str, Any] \| None` | — | +| `server` | `Implementation \| None` | — | + +**Returns:** `'ToolCallRequest'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx new file mode 100644 index 0000000000..4019e74db2 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx @@ -0,0 +1,22 @@ +--- +title: "ToolCallResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallResponse +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallResponse +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `action` | `Literal['accept', 'reject']` | — | diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx new file mode 100644 index 0000000000..f12e743431 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx @@ -0,0 +1,24 @@ +--- +title: "ToolCallServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallServer +```python +from agentstack_sdk.a2a.extensions.tools import ToolCallServer +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | `Field(description='The programmatic name...` | +| `title` | `str \| None` | `Field(description='A human-readable titl...` | +| `version` | `str` | `Field(description='The version of the se...` | diff --git a/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx b/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx new file mode 100644 index 0000000000..b143aa7801 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx @@ -0,0 +1,31 @@ +--- +title: "AgentArtifact" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / AgentArtifact +```python +from agentstack_sdk.a2a.types import AgentArtifact +``` +**Bases:** `Artifact` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `artifact_id` | `str` | `Field(default_factory=(lambda: str(uuid....` | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart]` | — | + +## Methods + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx b/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx new file mode 100644 index 0000000000..b214702530 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx @@ -0,0 +1,33 @@ +--- +title: "AgentMessage" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / AgentMessage +```python +from agentstack_sdk.a2a.types import AgentMessage +``` +**Bases:** `Message` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `message_id` | `str` | `Field(default_factory=(lambda: str(uuid....` | +| `role` | `Literal[Role.agent]` | `Role.agent` | +| `text` | `str \| None` | `Field(default=None, exclude=True)` | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart]` | `Field(default_factory=list)` | + +## Methods + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx b/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx new file mode 100644 index 0000000000..21831a37cc --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx @@ -0,0 +1,31 @@ +--- +title: "ArtifactChunk" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / ArtifactChunk +```python +from agentstack_sdk.a2a.types import ArtifactChunk +``` +**Bases:** `Artifact` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `last_chunk` | `bool` | `False` | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart]` | — | + +## Methods + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx b/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx new file mode 100644 index 0000000000..acf590cebc --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx @@ -0,0 +1,22 @@ +--- +title: "AuthRequired" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / AuthRequired +```python +from agentstack_sdk.a2a.types import AuthRequired +``` +**Bases:** `InputRequired` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `state` | `Literal[TaskState.auth_required]` | `TaskState.auth_required` | diff --git a/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx b/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx new file mode 100644 index 0000000000..f188523fab --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx @@ -0,0 +1,33 @@ +--- +title: "InputRequired" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / InputRequired +```python +from agentstack_sdk.a2a.types import InputRequired +``` +**Bases:** `TaskStatus` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `message` | `Message \| None` | `None` | +| `state` | `Literal[TaskState.input_required]` | `TaskState.input_required` | +| `text` | `str \| None` | `Field(default=None, exclude=True)` | +| `parts` | `list[Part \| TextPart \| DataPart \| FilePart]` | `Field(exclude=True, default_factory=list...` | + +## Methods + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-types/Metadata.mdx b/docs/development/reference/python-sdk/a2a-types/Metadata.mdx new file mode 100644 index 0000000000..da05e12908 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-types/Metadata.mdx @@ -0,0 +1,17 @@ +--- +title: "Metadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / Metadata +```python +from agentstack_sdk.a2a.types import Metadata +``` +**Bases:** `dict[str, JsonValue]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui.mdx b/docs/development/reference/python-sdk/a2a-ui.mdx new file mode 100644 index 0000000000..1f27eb6bea --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui.mdx @@ -0,0 +1,112 @@ +--- +title: "UI Extensions" +description: "Rich UI component extensions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetail, AgentDetailContributor, AgentDetailExtensionClient # ... +``` +--- +### Classes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `DEFAULT_ERROR_EXTENSION` | *constant* | `Final` | +| `SettingsFieldValue` | *union_alias* | `CheckboxGroupFieldValue \| SingleSelectFieldValue` | diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx new file mode 100644 index 0000000000..f16112ad2b --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx @@ -0,0 +1,34 @@ +--- +title: "AgentDetail" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetail +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetail +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `interaction_mode` | `str \| None` | `pydantic.Field('multi-turn', examples=['...` | +| `user_greeting` | `str \| None` | `None` | +| `input_placeholder` | `str \| None` | `None` | +| `tools` | `list[AgentDetailTool] \| None` | `None` | +| `framework` | `str \| None` | `None` | +| `license` | `str \| None` | `None` | +| `programming_language` | `str \| None` | `'Python'` | +| `homepage_url` | `str \| None` | `None` | +| `source_code_url` | `str \| None` | `None` | +| `container_image_url` | `str \| None` | `None` | +| `author` | `AgentDetailContributor \| None` | `None` | +| `contributors` | `list[AgentDetailContributor] \| None` | `None` | +| `variables` | `list[EnvVar] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx new file mode 100644 index 0000000000..b106f43083 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx @@ -0,0 +1,24 @@ +--- +title: "AgentDetailContributor" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailContributor +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetailContributor +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | — | +| `email` | `str \| None` | `None` | +| `url` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx new file mode 100644 index 0000000000..1a9473500b --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "AgentDetailExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailExtensionClient +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetailExtensionClient +``` +**Bases:** `BaseExtensionClient[AgentDetailExtensionSpec, AgentDetail]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx new file mode 100644 index 0000000000..b52da18a6a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx @@ -0,0 +1,17 @@ +--- +title: "AgentDetailExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetailExtensionServer +``` +**Bases:** `BaseExtensionServer[AgentDetailExtensionSpec, NoneType]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx new file mode 100644 index 0000000000..ae266f864c --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "AgentDetailExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetailExtensionSpec +``` +**Bases:** `BaseExtensionSpec[AgentDetail]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx new file mode 100644 index 0000000000..941e9e6a15 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx @@ -0,0 +1,23 @@ +--- +title: "AgentDetailTool" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailTool +```python +from agentstack_sdk.a2a.extensions.ui import AgentDetailTool +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | — | +| `description` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx new file mode 100644 index 0000000000..4bda5f50c0 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx @@ -0,0 +1,22 @@ +--- +title: "AgentRunSettings" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentRunSettings +```python +from agentstack_sdk.a2a.extensions.ui import AgentRunSettings +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `values` | `dict[str, SettingsFieldValue]` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx new file mode 100644 index 0000000000..2e014888dc --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx @@ -0,0 +1,25 @@ +--- +title: "CanvasEditRequest" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasEditRequest +```python +from agentstack_sdk.a2a.extensions.ui import CanvasEditRequest +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `start_index` | `int` | — | +| `end_index` | `int` | — | +| `description` | `str` | — | +| `artifact` | `Artifact` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx new file mode 100644 index 0000000000..d565073d67 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx @@ -0,0 +1,25 @@ +--- +title: "CanvasEditRequestMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasEditRequestMetadata +```python +from agentstack_sdk.a2a.extensions.ui import CanvasEditRequestMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `start_index` | `int` | — | +| `end_index` | `int` | — | +| `description` | `str` | — | +| `artifact_id` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx new file mode 100644 index 0000000000..37d162eefd --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx @@ -0,0 +1,42 @@ +--- +title: "CanvasExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import CanvasExtensionServer +``` +**Bases:** `BaseExtensionServer[CanvasExtensionSpec, CanvasEditRequestMetadata]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | + +**Returns:** `CanvasEditRequest | None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx new file mode 100644 index 0000000000..b360ae8ce1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "CanvasExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import CanvasExtensionSpec +``` +**Bases:** `NoParamsBaseExtensionSpec` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx new file mode 100644 index 0000000000..420ed40961 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx @@ -0,0 +1,24 @@ +--- +title: "CheckboxField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxField +```python +from agentstack_sdk.a2a.extensions.ui import CheckboxField +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `label` | `str` | — | +| `default_value` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx new file mode 100644 index 0000000000..bb64b4514c --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx @@ -0,0 +1,22 @@ +--- +title: "CheckboxFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxFieldValue +```python +from agentstack_sdk.a2a.extensions.ui import CheckboxFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `value` | `bool \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx new file mode 100644 index 0000000000..4f4c20d4cf --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx @@ -0,0 +1,24 @@ +--- +title: "CheckboxGroupField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxGroupField +```python +from agentstack_sdk.a2a.extensions.ui import CheckboxGroupField +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `type` | `Literal['checkbox_group']` | `'checkbox_group'` | +| `fields` | `list[CheckboxField]` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx new file mode 100644 index 0000000000..3da9444a60 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "CheckboxGroupFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxGroupFieldValue +```python +from agentstack_sdk.a2a.extensions.ui import CheckboxGroupFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['checkbox_group']` | `'checkbox_group'` | +| `values` | `dict[str, CheckboxFieldValue]` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/Citation.mdx b/docs/development/reference/python-sdk/a2a-ui/Citation.mdx new file mode 100644 index 0000000000..b66dd295ed --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/Citation.mdx @@ -0,0 +1,47 @@ +--- +title: "Citation" +description: "Represents an inline citation, providing info about information source. This" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / Citation +```python +from agentstack_sdk.a2a.extensions.ui import Citation +``` +**Bases:** `BaseModel` +is supposed to be rendered as an inline icon, optionally marking a text +range it belongs to. + +If Citation is included together with content in the message part, +the citation belongs to that content and renders at the Part position. +This way may be used for non-text content, like images and files. + +Alternatively, `start_index` and `end_index` may define a text range, +counting characters in the current Message across all Parts containing plain +text, where the citation will be rendered. If one of `start_index` and +`end_index` is missing or their values are equal, the citation renders only +as an inline icon at that position. + +If both `start_index` and `end_index` are not present and Part has empty +content, the citation renders as inline icon only at the Part position. + +Properties: +- url: URL of the source document. +- title: Title of the source document. +- description: Accompanying text, which may be a general description of the + source document, or a specific snippet. +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `start_index` | `int \| None` | `None` | +| `end_index` | `int \| None` | `None` | +| `url` | `str \| None` | `None` | +| `title` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx new file mode 100644 index 0000000000..d6ef3845ad --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "CitationExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationExtensionClient +```python +from agentstack_sdk.a2a.extensions.ui import CitationExtensionClient +``` +**Bases:** `BaseExtensionClient[CitationExtensionSpec, CitationMetadata]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx new file mode 100644 index 0000000000..325b9ef448 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx @@ -0,0 +1,45 @@ +--- +title: "CitationExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import CitationExtensionServer +``` +**Bases:** `BaseExtensionServer[CitationExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `citations` | `list[Citation]` | — | + +**Returns:** `Metadata` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `text` | `str \| None` | — | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart] \| None` | — | +| `citations` | `list[Citation]` | — | + +**Returns:** `AgentMessage` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx new file mode 100644 index 0000000000..cd7af7ca92 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "CitationExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import CitationExtensionSpec +``` +**Bases:** `NoParamsBaseExtensionSpec` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx new file mode 100644 index 0000000000..f5e234bae3 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx @@ -0,0 +1,22 @@ +--- +title: "CitationMetadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationMetadata +```python +from agentstack_sdk.a2a.extensions.ui import CitationMetadata +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `citations` | `list[Citation]` | `pydantic.Field(default_factory=list)` | diff --git a/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx b/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx new file mode 100644 index 0000000000..4d960e1574 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx @@ -0,0 +1,24 @@ +--- +title: "EnvVar" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / EnvVar +```python +from agentstack_sdk.a2a.extensions.ui import EnvVar +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | — | +| `description` | `str \| None` | `None` | +| `required` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/a2a-ui/Error.mdx b/docs/development/reference/python-sdk/a2a-ui/Error.mdx new file mode 100644 index 0000000000..79b0bd86d6 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/Error.mdx @@ -0,0 +1,32 @@ +--- +title: "Error" +description: "Represents error information for displaying exceptions in the UI" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / Error +```python +from agentstack_sdk.a2a.extensions.ui import Error +``` +**Bases:** `BaseModel` +This extension helps display errors in a user-friendly way with: +- A clear error title (exception type) +- A descriptive error message + +Visually, this may appear as an error card in the UI. + +Properties: +- title: Title of the error (typically the exception class name). +- message: The error message describing what went wrong. +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `title` | `str` | — | +| `message` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx new file mode 100644 index 0000000000..d850d8ad62 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx @@ -0,0 +1,23 @@ +--- +title: "ErrorContext" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorContext +```python +from agentstack_sdk.a2a.extensions.ui import ErrorContext +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `server` | `ErrorExtensionServer` | `pydantic.Field(default=DEFAULT_ERROR_EXT...` | +| `context` | `JsonValue` | `pydantic.Field(default_factory=dict)` | diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx new file mode 100644 index 0000000000..96c57f8212 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "ErrorExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionClient +```python +from agentstack_sdk.a2a.extensions.ui import ErrorExtensionClient +``` +**Bases:** `BaseExtensionClient[ErrorExtensionSpec, ErrorMetadata]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx new file mode 100644 index 0000000000..907c3fe7bf --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx @@ -0,0 +1,24 @@ +--- +title: "ErrorExtensionParams" +description: "Configuration parameters for the error extension" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionParams +```python +from agentstack_sdk.a2a.extensions.ui import ErrorExtensionParams +``` +**Bases:** `BaseModel` +Properties: +- include_stacktrace: Whether to include stack traces in error messages (default: False). +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `include_stacktrace` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx new file mode 100644 index 0000000000..8ac9762940 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx @@ -0,0 +1,79 @@ +--- +title: "ErrorExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import ErrorExtensionServer +``` +**Bases:** `BaseExtensionServer[ErrorExtensionSpec, NoneType]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context` | `JsonValue` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `args` | `Any` | `()` | +| `kwargs` | `Any` | `{}` | + +**Returns:** `None` + + + + + +Set up request-scoped error context using ContextVar. +**Returns:** `AsyncIterator[None]` + + + +Create metadata for an error. + +Args: + error: The exception to convert to metadata + +Returns: + Metadata dictionary with error information +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `error` | `BaseException` | — | + +**Returns:** `Metadata` + + + +Create an AgentMessage with error metadata and serialized text representation. + +Args: + error: The exception to include in the message + +Returns: + AgentMessage with error metadata and markdown-formatted text +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `error` | `BaseException` | — | + +**Returns:** `AgentMessage` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx new file mode 100644 index 0000000000..74cce9dcf5 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "ErrorExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import ErrorExtensionSpec +``` +**Bases:** `BaseExtensionSpec[ErrorExtensionParams]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx new file mode 100644 index 0000000000..4b40d9b08d --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx @@ -0,0 +1,26 @@ +--- +title: "ErrorGroup" +description: "Represents a group of errors" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorGroup +```python +from agentstack_sdk.a2a.extensions.ui import ErrorGroup +``` +**Bases:** `BaseModel` +Properties: +- message: A message describing the group of errors. +- errors: A list of error objects. +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `message` | `str` | — | +| `errors` | `list[Error]` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx new file mode 100644 index 0000000000..84bc2fef37 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx @@ -0,0 +1,28 @@ +--- +title: "ErrorMetadata" +description: "Metadata containing an error (or group of errors) and an optional stack trace" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorMetadata +```python +from agentstack_sdk.a2a.extensions.ui import ErrorMetadata +``` +**Bases:** `BaseModel` +Properties: +- error: The error object or group of errors. +- stack_trace: Optional formatted stack trace for debugging. +- context: Optional context dictionary. +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `error` | `Error \| ErrorGroup` | — | +| `stack_trace` | `str \| None` | `None` | +| `context` | `JsonValue \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx new file mode 100644 index 0000000000..4884b6f89e --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "FormRequestExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / FormRequestExtensionClient +```python +from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionClient +``` +**Bases:** `BaseExtensionClient[FormRequestExtensionSpec, FormRender]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx new file mode 100644 index 0000000000..6531ce1120 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx @@ -0,0 +1,54 @@ +--- +title: "FormRequestExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / FormRequestExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionServer +``` +**Bases:** `BaseExtensionServer[FormRequestExtensionSpec, FormResponse]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `form` | `FormRender` | — | +| `model` | `type[T] \| None` | — | + +**Returns:** `T | FormResponse | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `message` | `A2AMessage` | — | +| `model` | `type[T] \| None` | — | + +**Returns:** `T | FormResponse | None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx new file mode 100644 index 0000000000..26de18cc88 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "FormRequestExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / FormRequestExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionSpec +``` +**Bases:** `NoParamsBaseExtensionSpec` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx b/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx new file mode 100644 index 0000000000..7ee6d4b588 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx @@ -0,0 +1,23 @@ +--- +title: "OptionItem" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / OptionItem +```python +from agentstack_sdk.a2a.extensions.ui import OptionItem +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `label` | `str` | — | +| `value` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx new file mode 100644 index 0000000000..783c986e87 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "SettingsExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsExtensionClient +```python +from agentstack_sdk.a2a.extensions.ui import SettingsExtensionClient +``` +**Bases:** `BaseExtensionClient[SettingsExtensionSpec, SettingsRender]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx new file mode 100644 index 0000000000..ba4925af7a --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx @@ -0,0 +1,27 @@ +--- +title: "SettingsExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import SettingsExtensionServer +``` +**Bases:** `BaseExtensionServer[SettingsExtensionSpec, AgentRunSettings]` +## Methods + + + + + + +**Returns:** `AgentRunSettings` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx new file mode 100644 index 0000000000..a2d9f8ce48 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "SettingsExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import SettingsExtensionSpec +``` +**Bases:** `BaseExtensionSpec[SettingsRender | None]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx new file mode 100644 index 0000000000..94daf6e5a5 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx @@ -0,0 +1,22 @@ +--- +title: "SettingsRender" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsRender +```python +from agentstack_sdk.a2a.extensions.ui import SettingsRender +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `fields` | `list[Annotated[CheckboxGroupField \| SingleSelectField, Field(discriminator='type')]]` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx b/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx new file mode 100644 index 0000000000..b9889a3c0f --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx @@ -0,0 +1,26 @@ +--- +title: "SingleSelectField" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SingleSelectField +```python +from agentstack_sdk.a2a.extensions.ui import SingleSelectField +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['single_select']` | `'single_select'` | +| `id` | `str` | — | +| `label` | `str` | — | +| `options` | `list[OptionItem]` | — | +| `default_value` | `str` | — | diff --git a/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx b/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx new file mode 100644 index 0000000000..4ecdb8d4a1 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx @@ -0,0 +1,23 @@ +--- +title: "SingleSelectFieldValue" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SingleSelectFieldValue +```python +from agentstack_sdk.a2a.extensions.ui import SingleSelectFieldValue +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['single_select']` | `'single_select'` | +| `value` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx b/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx new file mode 100644 index 0000000000..0684ee9f89 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx @@ -0,0 +1,39 @@ +--- +title: "Trajectory" +description: "Represents trajectory information for an agent's reasoning or tool execution" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / Trajectory +```python +from agentstack_sdk.a2a.extensions.ui import Trajectory +``` +**Bases:** `BaseModel` +steps. Helps track the agent's decision-making process and provides +transparency into how the agent arrived at its response. + +Trajectory can capture intermediate steps like: +- A reasoning step with a message +- A tool execution with tool name, input, and output + +This information can be used for debugging, audit trails, and providing +users with insight into the agent's thought process. + +Visually, this may appear as an accordion component in the UI. + +Properties: +- title: Title of the trajectory update. +- content: Markdown-formatted content of the trajectory update. +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `title` | `str \| None` | `None` | +| `content` | `str \| None` | `None` | +| `group_id` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx new file mode 100644 index 0000000000..80da6c54c7 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx @@ -0,0 +1,17 @@ +--- +title: "TrajectoryExtensionClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / TrajectoryExtensionClient +```python +from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionClient +``` +**Bases:** `BaseExtensionClient[TrajectoryExtensionSpec, Trajectory]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx new file mode 100644 index 0000000000..60763e4365 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx @@ -0,0 +1,48 @@ +--- +title: "TrajectoryExtensionServer" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / TrajectoryExtensionServer +```python +from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionServer +``` +**Bases:** `BaseExtensionServer[TrajectoryExtensionSpec, NoneType]` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `title` | `str \| None` | — | +| `content` | `str \| None` | — | +| `group_id` | `str \| None` | — | + +**Returns:** `Metadata` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `text` | `str \| None` | — | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart] \| None` | — | +| `trajectory_title` | `str \| None` | — | +| `trajectory_content` | `str \| None` | — | + +**Returns:** `AgentMessage` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx new file mode 100644 index 0000000000..60489dae9f --- /dev/null +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx @@ -0,0 +1,22 @@ +--- +title: "TrajectoryExtensionSpec" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / TrajectoryExtensionSpec +```python +from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionSpec +``` +**Bases:** `NoParamsBaseExtensionSpec` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `URI` | `str` | `'https://a2a-extensions.agentstack.beeai...` | diff --git a/docs/development/reference/python-sdk/a2a.mdx b/docs/development/reference/python-sdk/a2a.mdx new file mode 100644 index 0000000000..5047b4e699 --- /dev/null +++ b/docs/development/reference/python-sdk/a2a.mdx @@ -0,0 +1,32 @@ +--- +title: "A2A Extensions" +description: "Extensions for the A2A protocol — authentication, services, tools, UI, and interactions" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} + + + OAuth and secrets authentication + + + Shared base classes and form types + + + Human-in-the-loop interaction extensions + + + LLM, embedding, MCP, and platform services + + + Tool call approval extensions + + + Rich UI component extensions + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/overview.mdx b/docs/development/reference/python-sdk/overview.mdx new file mode 100644 index 0000000000..d9ba5a8176 --- /dev/null +++ b/docs/development/reference/python-sdk/overview.mdx @@ -0,0 +1,35 @@ +--- +title: "Python SDK Reference" +description: "Complete reference for the Agent Stack Python SDK (agentstack-sdk)" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} + +The Agent Stack Python SDK (`agentstack-sdk`) provides the tools to build, run, and integrate +A2A-compatible agents with the Agent Stack platform. + +Install with: + +```bash +pip install agentstack-sdk +``` + +## Modules + + + Core server for creating and running A2A-compatible agents + + Extensions for authentication, services, tools, UI, and interactions + + Clients for files, vector stores, contexts, providers, and more + + Core type definitions and base classes + + Utility helpers + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform.mdx b/docs/development/reference/python-sdk/platform.mdx new file mode 100644 index 0000000000..9ede899cdb --- /dev/null +++ b/docs/development/reference/python-sdk/platform.mdx @@ -0,0 +1,244 @@ +--- +title: "Platform API" +description: "Clients for files, vector stores, contexts, providers, and more" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.platform import PlatformClient, SystemConfiguration, AuthorizationCodeRequest # ... +``` +--- + +## Client + +```python +from agentstack_sdk.platform.client import PlatformClient, get_platform_client, set_platform_client # ... +``` +### Classes + + + + + +### Functions + + + + + + + + + +--- + +## Configuration + +```python +from agentstack_sdk.platform.configuration import SystemConfiguration +``` +### Classes + + + + + +--- + +## Connector + +```python +from agentstack_sdk.platform.connector import AuthorizationCodeRequest, Connector, ConnectorPreset # ... +``` +### Classes + + + + + + + + + + + + + +### Functions + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `UuidStr` | *special_form* | `Annotated[UUID \| str, BeforeValidator(uuid_to_str)]` | + +--- + +## File + +```python +from agentstack_sdk.platform.file import ExtractedFileInfo, Extraction, File +``` +### Classes + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `ExtractionFormatLiteral` | *special_form* | `Literal['markdown', 'vendor_specific_json']` | + +--- + +## Model Provider + +```python +from agentstack_sdk.platform.model_provider import ModelCapability, ModelProvider, ModelProviderState # ... +``` +### Classes + + + + + + + + + + + + + +--- + +## Provider + +```python +from agentstack_sdk.platform.provider import EnvVar, Provider, ProviderErrorMessage # ... +``` +### Classes + + + + + + + + + + + +--- + +## Provider Build + +```python +from agentstack_sdk.platform.provider_build import AddProvider, BuildConfiguration, BuildState # ... +``` +### Classes + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `OnCompleteAction` | *type_alias* | `AddProvider \| UpdateProvider \| NoAction` | + +--- + +## Provider Discovery + +```python +from agentstack_sdk.platform.provider_discovery import DiscoveryState, ProviderDiscovery +``` +### Classes + + + + + + + +--- + +## User + +```python +from agentstack_sdk.platform.user import ChangeRoleResponse, User, UserRole +``` +### Classes + + + + + + + + + +--- + +## User Feedback + +```python +from agentstack_sdk.platform.user_feedback import ListUserFeedbackResponse, UserFeedback +``` +### Classes + + + + + + + +--- + +## Vector Store + +```python +from agentstack_sdk.platform.vector_store import VectorStore, VectorStoreDocument, VectorStoreItem # ... +``` +### Classes + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/AddProvider.mdx b/docs/development/reference/python-sdk/platform/AddProvider.mdx new file mode 100644 index 0000000000..abe953a584 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/AddProvider.mdx @@ -0,0 +1,25 @@ +--- +title: "AddProvider" +description: "Will add a new provider or update an existing one with the same base docker image ID" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / AddProvider +```python +from agentstack_sdk.platform import AddProvider +``` +**Bases:** `BaseModel` +(docker registry + repository, excluding tag) +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['add_provider']` | `'add_provider'` | +| `auto_stop_timeout_sec` | `int \| None` | — | +| `variables` | `dict[str, str] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx b/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx new file mode 100644 index 0000000000..654c3a303f --- /dev/null +++ b/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx @@ -0,0 +1,23 @@ +--- +title: "AuthorizationCodeRequest" +description: "Authorization request for code-based OAuth flow" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / AuthorizationCodeRequest +```python +from agentstack_sdk.platform import AuthorizationCodeRequest +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['code']` | `'code'` | +| `authorization_endpoint` | `AnyUrl` | — | diff --git a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx new file mode 100644 index 0000000000..f0078a08af --- /dev/null +++ b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx @@ -0,0 +1,22 @@ +--- +title: "BuildConfiguration" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / BuildConfiguration +```python +from agentstack_sdk.platform import BuildConfiguration +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `dockerfile_path` | `Path \| None` | — | diff --git a/docs/development/reference/python-sdk/platform/BuildState.mdx b/docs/development/reference/python-sdk/platform/BuildState.mdx new file mode 100644 index 0000000000..1655e484a3 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/BuildState.mdx @@ -0,0 +1,26 @@ +--- +title: "BuildState" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / BuildState +```python +from agentstack_sdk.platform import BuildState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `MISSING` | — | `'missing'` | +| `IN_PROGRESS` | — | `'in_progress'` | +| `BUILD_COMPLETED` | — | `'build_completed'` | +| `COMPLETED` | — | `'completed'` | +| `FAILED` | — | `'failed'` | diff --git a/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx b/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx new file mode 100644 index 0000000000..86340ab644 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx @@ -0,0 +1,23 @@ +--- +title: "ChangeRoleResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ChangeRoleResponse +```python +from agentstack_sdk.platform import ChangeRoleResponse +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `user_id` | `str` | — | +| `new_role` | `UserRole` | — | diff --git a/docs/development/reference/python-sdk/platform/Connector.mdx b/docs/development/reference/python-sdk/platform/Connector.mdx new file mode 100644 index 0000000000..ef1ac25f93 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/Connector.mdx @@ -0,0 +1,234 @@ +--- +title: "Connector" +description: "Represents a configured connector instance" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Connector +```python +from agentstack_sdk.platform import Connector +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | — | +| `url` | `AnyUrl` | — | +| `state` | `ConnectorState` | — | +| `auth_request` | `AuthorizationCodeRequest \| None` | `None` | +| `disconnect_reason` | `str \| None` | `None` | +| `metadata` | `Metadata \| None` | `None` | +| `created_at` | `AwareDatetime \| None` | `None` | +| `updated_at` | `AwareDatetime \| None` | `None` | +| `created_by` | `UUID \| None` | `None` | + +## Methods + + + + + + +Create a new connector. + +Args: + url: The URL of the connector/MCP server + client_id: OAuth client ID (optional) + client_secret: OAuth client secret (optional) + metadata: Additional metadata for the connector (optional) + match_preset: Whether to match against preset connectors + client: Optional PlatformClient instance + +Returns: + The created Connector instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `url` | `AnyUrl \| str` | — | +| `client_id` | `str \| None` | — | +| `client_secret` | `str \| None` | — | +| `metadata` | `Metadata \| None` | — | +| `match_preset` | `bool` | `True` | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +List all connectors for the current user. + +Returns: + A paginated list of Connector instances +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['Connector']` + + + +Read a specific connector by ID. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Delete a connector. + +Args: + client: Optional PlatformClient instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +This is just a syntactic sugar for calling Connector.get(). +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Wait for the connector to reach connected state. + +This is useful after calling connect() and opening the browser for OAuth. +It will poll the server until the connector reaches 'connected' state or +timeout is exceeded. + +Args: + poll_interval: Seconds between polls (default: 2) + client: Optional PlatformClient instance + +Returns: + Updated Connector instance when connected + +Raises: + TimeoutError: If connector doesn't reach connected state within timeout (300 seconds) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `state` | `ConnectorState` | `ConnectorState.connected` | +| `poll_interval` | `int` | `1` | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `poll_interval` | `int` | `1` | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +Connect a connector (establish authorization). + +If the connector requires OAuth authorization, this will automatically +open the browser with the authorization endpoint. + +Args: + redirect_url: OAuth redirect URL (optional) + access_token: OAuth access token (optional) + client: Optional PlatformClient instance + +Returns: + The updated Connector instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `redirect_url` | `AnyUrl \| str \| None` | — | +| `access_token` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Disconnect a connector. + +Args: + client: Optional PlatformClient instance + +Returns: + The updated Connector instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Proxy a streaming request through to the connector's MCP endpoint. + +This allows direct communication with the Model Context Protocol server +exposed by the connector. The response is streamed to avoid loading +large responses into memory. + +Args: + method: HTTP method (GET, POST, etc.) + headers: Optional HTTP headers to include + content: Optional request body content + client: Optional PlatformClient instance + +Yields: + Response content chunks as bytes +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `method` | `str` | — | +| `headers` | `dict \| None` | — | +| `content` | `bytes \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[MCPProxyResponse]` + + + +List all available connector presets. + +Returns: + A paginated list of ConnectorPreset instances +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['ConnectorPreset']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx b/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx new file mode 100644 index 0000000000..bb0aefc8dc --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx @@ -0,0 +1,23 @@ +--- +title: "ConnectorPreset" +description: "Represents a preset connector configuration" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ConnectorPreset +```python +from agentstack_sdk.platform import ConnectorPreset +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `url` | `AnyUrl` | — | +| `metadata` | `Metadata \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/ConnectorState.mdx b/docs/development/reference/python-sdk/platform/ConnectorState.mdx new file mode 100644 index 0000000000..d3cd1d11b7 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ConnectorState.mdx @@ -0,0 +1,25 @@ +--- +title: "ConnectorState" +description: "Enumeration of possible connector states" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ConnectorState +```python +from agentstack_sdk.platform import ConnectorState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `created` | — | `'created'` | +| `auth_required` | — | `'auth_required'` | +| `connected` | — | `'connected'` | +| `disconnected` | — | `'disconnected'` | diff --git a/docs/development/reference/python-sdk/platform/Context.mdx b/docs/development/reference/python-sdk/platform/Context.mdx new file mode 100644 index 0000000000..cd5d565c14 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/Context.mdx @@ -0,0 +1,171 @@ +--- +title: "Context" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Context +```python +from agentstack_sdk.platform import Context +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `created_at` | `AwareDatetime` | — | +| `updated_at` | `AwareDatetime` | — | +| `last_active_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | +| `provider_id` | `str \| None` | `None` | +| `metadata` | `Metadata \| None` | `None` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `metadata` | `Metadata \| None` | — | +| `provider_id` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Context'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `page_token` | `str \| None` | — | +| `limit` | `int \| None` | — | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | — | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | +| `include_empty` | `bool` | `True` | +| `provider_id` | `str \| None` | — | + +**Returns:** `PaginatedResult['Context']` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Context'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `metadata` | `Metadata \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Context'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `metadata` | `MetadataPatch \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Context'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +Generate token for agent authentication + +@param grant_global_permissions: Global permissions granted by the token. Must be subset of the users permissions +@param grant_context_permissions: Context permissions granted by the token. Must be subset of the users permissions +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `providers` | `builtins.list[str] \| builtins.list[Provider] \| None` | — | +| `client` | `PlatformClient \| None` | — | +| `grant_global_permissions` | `Permissions \| None` | — | +| `grant_context_permissions` | `ContextPermissions \| None` | — | + +**Returns:** `ContextToken` + + + +Add a Message or Artifact to the context history (append-only) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +Delete all history items from a specific item onwards (inclusive) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID \| str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +List all history items for this context in chronological order +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `page_token` | `str \| None` | — | +| `limit` | `int \| None` | — | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult[ContextHistoryItem]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[ContextHistoryItem]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx b/docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx new file mode 100644 index 0000000000..3105d00547 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx @@ -0,0 +1,26 @@ +--- +title: "ContextHistoryItem" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ContextHistoryItem +```python +from agentstack_sdk.platform import ContextHistoryItem +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | `Field(default_factory=uuid4)` | +| `data` | `Artifact \| Message` | — | +| `created_at` | `AwareDatetime` | `Field(default_factory=utc_now)` | +| `context_id` | `str` | — | +| `kind` | `Literal['message', 'artifact']` | — | diff --git a/docs/development/reference/python-sdk/platform/ContextPermissions.mdx b/docs/development/reference/python-sdk/platform/ContextPermissions.mdx new file mode 100644 index 0000000000..f2a1cbbc59 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ContextPermissions.mdx @@ -0,0 +1,24 @@ +--- +title: "ContextPermissions" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ContextPermissions +```python +from agentstack_sdk.platform import ContextPermissions +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `files` | `set[Literal['read', 'write', 'extract', '*']]` | `set()` | +| `vector_stores` | `set[Literal['read', 'write', '*']]` | `set()` | +| `context_data` | `set[Literal['read', 'write', '*']]` | `set()` | diff --git a/docs/development/reference/python-sdk/platform/ContextToken.mdx b/docs/development/reference/python-sdk/platform/ContextToken.mdx new file mode 100644 index 0000000000..95f444e4e8 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ContextToken.mdx @@ -0,0 +1,24 @@ +--- +title: "ContextToken" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ContextToken +```python +from agentstack_sdk.platform import ContextToken +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context_id` | `str` | — | +| `token` | `Secret[str]` | — | +| `expires_at` | `AwareDatetime \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/DiscoveryState.mdx b/docs/development/reference/python-sdk/platform/DiscoveryState.mdx new file mode 100644 index 0000000000..185d1191ac --- /dev/null +++ b/docs/development/reference/python-sdk/platform/DiscoveryState.mdx @@ -0,0 +1,25 @@ +--- +title: "DiscoveryState" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / DiscoveryState +```python +from agentstack_sdk.platform import DiscoveryState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `PENDING` | — | `'pending'` | +| `IN_PROGRESS` | — | `'in_progress'` | +| `COMPLETED` | — | `'completed'` | +| `FAILED` | — | `'failed'` | diff --git a/docs/development/reference/python-sdk/platform/EnvVar.mdx b/docs/development/reference/python-sdk/platform/EnvVar.mdx new file mode 100644 index 0000000000..11aba0369f --- /dev/null +++ b/docs/development/reference/python-sdk/platform/EnvVar.mdx @@ -0,0 +1,24 @@ +--- +title: "EnvVar" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / EnvVar +```python +from agentstack_sdk.platform import EnvVar +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | — | +| `description` | `str \| None` | `None` | +| `required` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx b/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx new file mode 100644 index 0000000000..b2a7defd8e --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx @@ -0,0 +1,23 @@ +--- +title: "ExtractedFileInfo" +description: "Information about an extracted file" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ExtractedFileInfo +```python +from agentstack_sdk.platform import ExtractedFileInfo +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `file_id` | `str` | — | +| `format` | `ExtractionFormatLiteral \| None` | — | diff --git a/docs/development/reference/python-sdk/platform/Extraction.mdx b/docs/development/reference/python-sdk/platform/Extraction.mdx new file mode 100644 index 0000000000..44bf8fa704 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/Extraction.mdx @@ -0,0 +1,31 @@ +--- +title: "Extraction" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Extraction +```python +from agentstack_sdk.platform import Extraction +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `file_id` | `str` | — | +| `extracted_files` | `builtins.list[ExtractedFileInfo]` | `pydantic.Field(default_factory=list)` | +| `status` | `Literal['pending', 'in_progress', 'completed', 'failed', 'cancelled']` | `'pending'` | +| `job_id` | `str \| None` | `None` | +| `error_message` | `str \| None` | `None` | +| `extraction_metadata` | `dict[str, typing.Any] \| None` | `None` | +| `started_at` | `AwareDatetime \| None` | `None` | +| `finished_at` | `AwareDatetime \| None` | `None` | +| `created_at` | `AwareDatetime` | — | diff --git a/docs/development/reference/python-sdk/platform/File.mdx b/docs/development/reference/python-sdk/platform/File.mdx new file mode 100644 index 0000000000..7df737bff0 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/File.mdx @@ -0,0 +1,164 @@ +--- +title: "File" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / File +```python +from agentstack_sdk.platform import File +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `filename` | `str` | — | +| `content_type` | `str` | — | +| `file_size_bytes` | `int` | — | +| `created_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | +| `file_type` | `Literal['user_upload', 'extracted_text']` | — | +| `parent_file_id` | `str \| None` | `None` | +| `url` | `PlatformFileUrl` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `filename` | `str` | — | +| `content` | `BinaryIO \| bytes` | — | +| `content_type` | `str` | `'application/octet-stream'` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'File'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'File'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `stream` | `bool` | `False` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `AsyncIterator[LoadedFile]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `stream` | `bool` | `False` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `AsyncIterator[LoadedFile]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `stream` | `bool` | `False` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `AsyncIterator[LoadedFile]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `formats` | `builtins.list[ExtractionFormatLiteral] \| None` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `Extraction` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `Extraction` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Returns:** `FilePart` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `content_type` | `str \| None` | — | +| `filename_search` | `str \| None` | — | +| `page_token` | `str \| None` | — | +| `limit` | `int \| None` | — | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | +| `order_by` | `Literal['created_at'] \| Literal['filename'] \| Literal['file_size_bytes'] \| None` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `PaginatedResult['File']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/GithubVersionType.mdx b/docs/development/reference/python-sdk/platform/GithubVersionType.mdx new file mode 100644 index 0000000000..d5ad870700 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/GithubVersionType.mdx @@ -0,0 +1,23 @@ +--- +title: "GithubVersionType" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / GithubVersionType +```python +from agentstack_sdk.platform import GithubVersionType +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `HEAD` | — | `'head'` | +| `TAG` | — | `'tag'` | diff --git a/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx b/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx new file mode 100644 index 0000000000..a5cf88b6ab --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx @@ -0,0 +1,17 @@ +--- +title: "ListUserFeedbackResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ListUserFeedbackResponse +```python +from agentstack_sdk.platform import ListUserFeedbackResponse +``` +**Bases:** `PaginatedResult[UserFeedback]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx b/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx new file mode 100644 index 0000000000..33e74d1a73 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx @@ -0,0 +1,24 @@ +--- +title: "MCPProxyResponse" +description: "Response from an MCP proxy request with headers and streaming content" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / MCPProxyResponse +```python +from agentstack_sdk.platform import MCPProxyResponse +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `headers` | `Annotated[dict[str, str], Field(description='HTTP headers from the proxy response')]` | — | +| `status_code` | `Annotated[int, Field(description='HTTP status code from the proxy response')]` | — | +| `chunk` | `Annotated[bytes, Field(description='Bytes chunk from streaming response content')]` | — | diff --git a/docs/development/reference/python-sdk/platform/ModelCapability.mdx b/docs/development/reference/python-sdk/platform/ModelCapability.mdx new file mode 100644 index 0000000000..47ecbb5b77 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ModelCapability.mdx @@ -0,0 +1,23 @@ +--- +title: "ModelCapability" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelCapability +```python +from agentstack_sdk.platform import ModelCapability +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `LLM` | — | `'llm'` | +| `EMBEDDING` | — | `'embedding'` | diff --git a/docs/development/reference/python-sdk/platform/ModelProvider.mdx b/docs/development/reference/python-sdk/platform/ModelProvider.mdx new file mode 100644 index 0000000000..ba60ba6b75 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ModelProvider.mdx @@ -0,0 +1,97 @@ +--- +title: "ModelProvider" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelProvider +```python +from agentstack_sdk.platform import ModelProvider +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `name` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | +| `type` | `ModelProviderType` | — | +| `base_url` | `HttpUrl` | — | +| `watsonx_project_id` | `str \| None` | `None` | +| `watsonx_space_id` | `str \| None` | `None` | +| `created_at` | `AwareDatetime` | — | +| `capabilities` | `set[ModelCapability]` | — | +| `state` | `ModelProviderState` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str \| None` | — | +| `description` | `str \| None` | — | +| `type` | `ModelProviderType` | — | +| `base_url` | `str \| pydantic.HttpUrl` | — | +| `watsonx_project_id` | `str \| None` | — | +| `watsonx_space_id` | `str \| None` | — | +| `api_key` | `str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ModelProvider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ModelProvider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `capability` | `ModelCapability` | `ModelCapability.LLM` | +| `suggested_models` | `tuple[str, ...] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `builtins.list[ModelWithScore]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `builtins.list['ModelProvider']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/ModelProviderState.mdx b/docs/development/reference/python-sdk/platform/ModelProviderState.mdx new file mode 100644 index 0000000000..4381b5c850 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ModelProviderState.mdx @@ -0,0 +1,23 @@ +--- +title: "ModelProviderState" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelProviderState +```python +from agentstack_sdk.platform import ModelProviderState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `ONLINE` | — | `'online'` | +| `OFFLINE` | — | `'offline'` | diff --git a/docs/development/reference/python-sdk/platform/ModelProviderType.mdx b/docs/development/reference/python-sdk/platform/ModelProviderType.mdx new file mode 100644 index 0000000000..2206adef51 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ModelProviderType.mdx @@ -0,0 +1,42 @@ +--- +title: "ModelProviderType" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelProviderType +```python +from agentstack_sdk.platform import ModelProviderType +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `ANTHROPIC` | — | `'anthropic'` | +| `CEREBRAS` | — | `'cerebras'` | +| `CHUTES` | — | `'chutes'` | +| `COHERE` | — | `'cohere'` | +| `DEEPSEEK` | — | `'deepseek'` | +| `GEMINI` | — | `'gemini'` | +| `GITHUB` | — | `'github'` | +| `GROQ` | — | `'groq'` | +| `WATSONX` | — | `'watsonx'` | +| `JAN` | — | `'jan'` | +| `MISTRAL` | — | `'mistral'` | +| `MOONSHOT` | — | `'moonshot'` | +| `NVIDIA` | — | `'nvidia'` | +| `OLLAMA` | — | `'ollama'` | +| `OPENAI` | — | `'openai'` | +| `OPENROUTER` | — | `'openrouter'` | +| `PERPLEXITY` | — | `'perplexity'` | +| `TOGETHER` | — | `'together'` | +| `VOYAGE` | — | `'voyage'` | +| `RITS` | — | `'rits'` | +| `OTHER` | — | `'other'` | diff --git a/docs/development/reference/python-sdk/platform/ModelWithScore.mdx b/docs/development/reference/python-sdk/platform/ModelWithScore.mdx new file mode 100644 index 0000000000..94cd7e1d6c --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ModelWithScore.mdx @@ -0,0 +1,23 @@ +--- +title: "ModelWithScore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelWithScore +```python +from agentstack_sdk.platform import ModelWithScore +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `model_id` | `str` | — | +| `score` | `float` | — | diff --git a/docs/development/reference/python-sdk/platform/NoAction.mdx b/docs/development/reference/python-sdk/platform/NoAction.mdx new file mode 100644 index 0000000000..de4b43e225 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/NoAction.mdx @@ -0,0 +1,22 @@ +--- +title: "NoAction" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / NoAction +```python +from agentstack_sdk.platform import NoAction +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['no_action']` | `'no_action'` | diff --git a/docs/development/reference/python-sdk/platform/PaginatedResult.mdx b/docs/development/reference/python-sdk/platform/PaginatedResult.mdx new file mode 100644 index 0000000000..f3098a838d --- /dev/null +++ b/docs/development/reference/python-sdk/platform/PaginatedResult.mdx @@ -0,0 +1,25 @@ +--- +title: "PaginatedResult" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / PaginatedResult +```python +from agentstack_sdk.platform import PaginatedResult +``` +**Bases:** `BaseModel , Generic[T]` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `items` | `list[T]` | — | +| `total_count` | `int` | — | +| `has_more` | `bool` | `False` | +| `next_page_token` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/Permissions.mdx b/docs/development/reference/python-sdk/platform/Permissions.mdx new file mode 100644 index 0000000000..ee19711a05 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/Permissions.mdx @@ -0,0 +1,30 @@ +--- +title: "Permissions" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Permissions +```python +from agentstack_sdk.platform import Permissions +``` +**Bases:** `ContextPermissions` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `llm` | `set[Literal['*'] \| str]` | `set()` | +| `embeddings` | `set[Literal['*'] \| str]` | `set()` | +| `a2a_proxy` | `set[Literal['*'] \| str]` | `set()` | +| `model_providers` | `set[Literal['read', 'write', '*']]` | `set()` | +| `variables` | `SerializeAsAny[set[Literal['read', 'write', '*']]]` | `set()` | +| `providers` | `set[Literal['read', 'write', '*']]` | `set()` | +| `provider_variables` | `set[Literal['read', 'write', '*']]` | `set()` | +| `contexts` | `set[Literal['read', 'write', '*']]` | `set()` | +| `connectors` | `set[Literal['read', 'write', 'proxy', '*']]` | `set()` | diff --git a/docs/development/reference/python-sdk/platform/PlatformClient.mdx b/docs/development/reference/python-sdk/platform/PlatformClient.mdx new file mode 100644 index 0000000000..fd7c9dc13e --- /dev/null +++ b/docs/development/reference/python-sdk/platform/PlatformClient.mdx @@ -0,0 +1,59 @@ +--- +title: "PlatformClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / PlatformClient +```python +from agentstack_sdk.platform import PlatformClient +``` +**Bases:** `AsyncClient` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context_id` | `str \| None` | `context_id` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str \| None` | — | +| `auth_token` | `str \| Secret[str] \| None` | — | +| `auth` | `AuthTypes \| None` | — | +| `params` | `QueryParamTypes \| None` | — | +| `headers` | `HeaderTypes \| None` | — | +| `cookies` | `CookieTypes \| None` | — | +| `verify` | `SSLContext \| str \| bool` | `True` | +| `cert` | `CertTypes \| None` | — | +| `http1` | `bool` | `True` | +| `http2` | `bool` | `False` | +| `proxy` | `ProxyTypes \| None` | — | +| `mounts` | `None \| Mapping[str, AsyncBaseTransport \| None]` | — | +| `timeout` | `TimeoutTypes` | `DEFAULT_SDK_TIMEOUT` | +| `follow_redirects` | `bool` | `False` | +| `limits` | `Limits` | `DEFAULT_LIMITS` | +| `max_redirects` | `int` | `DEFAULT_MAX_REDIRECTS` | +| `event_hooks` | `None \| Mapping[str, list[EventHook]]` | — | +| `base_url` | `URL \| str` | `''` | +| `transport` | `AsyncBaseTransport \| None` | — | +| `trust_env` | `bool` | `True` | +| `default_encoding` | `str \| typing.Callable[[bytes], str]` | `'utf-8'` | + +**Returns:** `None` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/Provider.mdx b/docs/development/reference/python-sdk/platform/Provider.mdx new file mode 100644 index 0000000000..3c5ef6ba45 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/Provider.mdx @@ -0,0 +1,166 @@ +--- +title: "Provider" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Provider +```python +from agentstack_sdk.platform import Provider +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `auto_stop_timeout` | `timedelta` | — | +| `source` | `str` | — | +| `origin` | `str` | — | +| `version_info` | `VersionInfo` | `pydantic.Field(default_factory=VersionIn...` | +| `registry` | `str \| None` | `None` | +| `created_at` | `AwareDatetime` | — | +| `updated_at` | `AwareDatetime` | — | +| `last_active_at` | `AwareDatetime` | — | +| `agent_card` | `AgentCard` | — | +| `state` | `Literal['missing', 'starting', 'ready', 'running', 'error', 'online', 'offline']` | `'missing'` | +| `managed` | `bool` | — | +| `last_error` | `ProviderErrorMessage \| None` | `None` | +| `created_by` | `UUID` | — | +| `missing_configuration` | `builtins.list[EnvVar]` | `pydantic.Field(default_factory=list)` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `agent_card` | `AgentCard \| None` | — | +| `origin` | `str \| None` | — | +| `auto_stop_timeout` | `timedelta \| None` | — | +| `variables` | `dict[str, str] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str \| None` | — | +| `agent_card` | `AgentCard \| None` | — | +| `origin` | `str \| None` | — | +| `auto_stop_timeout` | `timedelta \| None` | — | +| `variables` | `dict[str, str] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `agent_card` | `AgentCard \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `variables` | `dict[str, str \| None] \| dict[str, str]` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[dict[str, typing.Any]]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `dict[str, str]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `origin` | `str \| None` | — | +| `user_owned` | `bool \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `builtins.list['Provider']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/ProviderBuild.mdx b/docs/development/reference/python-sdk/platform/ProviderBuild.mdx new file mode 100644 index 0000000000..07ed07a24a --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ProviderBuild.mdx @@ -0,0 +1,108 @@ +--- +title: "ProviderBuild" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ProviderBuild +```python +from agentstack_sdk.platform import ProviderBuild +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `created_at` | `AwareDatetime` | — | +| `status` | `BuildState` | — | +| `source` | `ResolvedGithubUrl` | — | +| `destination` | `str` | — | +| `provider_id` | `str \| None` | `None` | +| `build_configuration` | `BuildConfiguration \| None` | `None` | +| `created_by` | `str` | — | +| `error_message` | `str \| None` | `None` | +| `provider_origin` | `str` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `on_complete` | `OnCompleteAction \| None` | — | +| `build_configuration` | `BuildConfiguration \| None` | — | + +**Returns:** `'ProviderBuild'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `on_complete` | `OnCompleteAction \| None` | — | + +**Returns:** `'ProviderBuild'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[dict[str, Any]]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ProviderBuild'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `page_token` | `str \| None` | — | +| `limit` | `int \| None` | — | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | +| `user_owned` | `bool \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['ProviderBuild']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx b/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx new file mode 100644 index 0000000000..0eca1d7efe --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx @@ -0,0 +1,56 @@ +--- +title: "ProviderDiscovery" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ProviderDiscovery +```python +from agentstack_sdk.platform import ProviderDiscovery +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | — | +| `created_at` | `AwareDatetime` | — | +| `status` | `DiscoveryState` | — | +| `docker_image` | `str` | — | +| `created_by` | `UUID` | — | +| `agent_card` | `AgentCard \| None` | `None` | +| `error_message` | `str \| None` | `None` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `docker_image` | `str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ProviderDiscovery'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ProviderDiscovery'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx b/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx new file mode 100644 index 0000000000..abb3e4375c --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx @@ -0,0 +1,22 @@ +--- +title: "ProviderErrorMessage" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ProviderErrorMessage +```python +from agentstack_sdk.platform import ProviderErrorMessage +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `message` | `str` | — | diff --git a/docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx b/docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx new file mode 100644 index 0000000000..f5ef8d1c72 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx @@ -0,0 +1,25 @@ +--- +title: "ResolvedDockerImageID" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ResolvedDockerImageID +```python +from agentstack_sdk.platform import ResolvedDockerImageID +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `registry` | `str` | — | +| `repository` | `str` | — | +| `tag` | `str` | — | +| `digest` | `str` | — | diff --git a/docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx b/docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx new file mode 100644 index 0000000000..b8160f6a55 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx @@ -0,0 +1,28 @@ +--- +title: "ResolvedGithubUrl" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ResolvedGithubUrl +```python +from agentstack_sdk.platform import ResolvedGithubUrl +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `host` | `str` | `'github.com'` | +| `org` | `str` | — | +| `repo` | `str` | — | +| `version` | `str` | — | +| `version_type` | `GithubVersionType` | — | +| `commit_hash` | `str` | — | +| `path` | `str \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx b/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx new file mode 100644 index 0000000000..46cca7c830 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx @@ -0,0 +1,57 @@ +--- +title: "SystemConfiguration" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / SystemConfiguration +```python +from agentstack_sdk.platform import SystemConfiguration +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `default_llm_model` | `str \| None` | `None` | +| `default_embedding_model` | `str \| None` | `None` | +| `updated_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | + +## Methods + + + + + + +Get the current system configuration. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'SystemConfiguration'` + + + +Update the system configuration. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `default_llm_model` | `str \| None` | — | +| `default_embedding_model` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'SystemConfiguration'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/UpdateProvider.mdx b/docs/development/reference/python-sdk/platform/UpdateProvider.mdx new file mode 100644 index 0000000000..1b130e648b --- /dev/null +++ b/docs/development/reference/python-sdk/platform/UpdateProvider.mdx @@ -0,0 +1,23 @@ +--- +title: "UpdateProvider" +description: "Will update provider specified by ID" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / UpdateProvider +```python +from agentstack_sdk.platform import UpdateProvider +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['update_provider']` | `'update_provider'` | +| `provider_id` | `UUID` | — | diff --git a/docs/development/reference/python-sdk/platform/User.mdx b/docs/development/reference/python-sdk/platform/User.mdx new file mode 100644 index 0000000000..f79e792508 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/User.mdx @@ -0,0 +1,67 @@ +--- +title: "User" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / User +```python +from agentstack_sdk.platform import User +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `role` | `UserRole` | — | +| `email` | `str` | — | +| `created_at` | `AwareDatetime` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'User'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `email` | `str \| None` | — | +| `limit` | `int` | `40` | +| `page_token` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['User']` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `user_id` | `str` | — | +| `new_role` | `UserRole` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `ChangeRoleResponse` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/UserFeedback.mdx b/docs/development/reference/python-sdk/platform/UserFeedback.mdx new file mode 100644 index 0000000000..248bb96f15 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/UserFeedback.mdx @@ -0,0 +1,51 @@ +--- +title: "UserFeedback" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / UserFeedback +```python +from agentstack_sdk.platform import UserFeedback +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | — | +| `provider_id` | `UUID` | — | +| `task_id` | `UUID` | — | +| `context_id` | `UUID` | — | +| `rating` | `int` | — | +| `message` | `str` | — | +| `comment` | `str \| None` | `None` | +| `comment_tags` | `builtins.list[str] \| None` | `None` | +| `created_at` | `datetime` | — | +| `agent_name` | `str` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `provider_id` | `str \| None` | — | +| `limit` | `int` | `50` | +| `after_cursor` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ListUserFeedbackResponse'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/UserRole.mdx b/docs/development/reference/python-sdk/platform/UserRole.mdx new file mode 100644 index 0000000000..99b48d02b6 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/UserRole.mdx @@ -0,0 +1,24 @@ +--- +title: "UserRole" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / UserRole +```python +from agentstack_sdk.platform import UserRole +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `ADMIN` | — | `'admin'` | +| `DEVELOPER` | — | `'developer'` | +| `USER` | — | `'user'` | diff --git a/docs/development/reference/python-sdk/platform/Variables.mdx b/docs/development/reference/python-sdk/platform/Variables.mdx new file mode 100644 index 0000000000..1d3c51eeaf --- /dev/null +++ b/docs/development/reference/python-sdk/platform/Variables.mdx @@ -0,0 +1,51 @@ +--- +title: "Variables" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Variables +```python +from agentstack_sdk.platform import Variables +``` +**Bases:** `dict[str, str]` +## Methods + + + + + + +Save variables to the Agent Stack platform. Does not delete keys unless explicitly set to None. + +Can be used as a class method: Variables.save(\{"key": "value", ...\}) +...or as an instance method: variables.save() +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +Load variables from the Agent Stack platform. + +Can be used as a class method: variables = Variables.load() +...or as an instance method to update the instance: variables.load() +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Variables'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/VectorStore.mdx b/docs/development/reference/python-sdk/platform/VectorStore.mdx new file mode 100644 index 0000000000..54c650b836 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/VectorStore.mdx @@ -0,0 +1,120 @@ +--- +title: "VectorStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStore +```python +from agentstack_sdk.platform import VectorStore +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `name` | `str \| None` | `None` | +| `model_id` | `str` | — | +| `dimension` | `int` | — | +| `created_at` | `AwareDatetime` | — | +| `last_active_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | +| `stats` | `VectorStoreStats \| None` | `None` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str` | — | +| `dimension` | `int` | — | +| `model_id` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'VectorStore'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'VectorStore'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `items` | `list[VectorStoreItem]` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `query_vector` | `list[float]` | — | +| `limit` | `int` | `10` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `list[VectorStoreSearchResult]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `list[VectorStoreDocument]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `document_id` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx b/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx new file mode 100644 index 0000000000..b46b5d6935 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx @@ -0,0 +1,26 @@ +--- +title: "VectorStoreDocument" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreDocument +```python +from agentstack_sdk.platform import VectorStoreDocument +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `vector_store_id` | `str` | — | +| `file_id` | `str \| None` | `None` | +| `usage_bytes` | `int \| None` | `None` | +| `created_at` | `AwareDatetime` | — | diff --git a/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx b/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx new file mode 100644 index 0000000000..232662e9b9 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx @@ -0,0 +1,40 @@ +--- +title: "VectorStoreItem" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreItem +```python +from agentstack_sdk.platform import VectorStoreItem +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | `pydantic.Field(default_factory=(lambda: ...` | +| `document_id` | `str` | — | +| `document_type` | `Literal['platform_file', 'external'] \| None` | `'platform_file'` | +| `model_id` | `str \| typing.Literal['platform']` | `'platform'` | +| `text` | `str` | — | +| `embedding` | `list[float]` | — | +| `metadata` | `Metadata \| None` | `None` | + +## Methods + + + + + + +Validate that document_id is a valid UUID when document_type is platform_file. +**Returns:** `Self` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx b/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx new file mode 100644 index 0000000000..5a64226889 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx @@ -0,0 +1,23 @@ +--- +title: "VectorStoreSearchResult" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreSearchResult +```python +from agentstack_sdk.platform import VectorStoreSearchResult +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `item` | `VectorStoreItem` | — | +| `score` | `float` | — | diff --git a/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx b/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx new file mode 100644 index 0000000000..6c01c59918 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx @@ -0,0 +1,23 @@ +--- +title: "VectorStoreStats" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreStats +```python +from agentstack_sdk.platform import VectorStoreStats +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `usage_bytes` | `int` | — | +| `num_documents` | `int` | — | diff --git a/docs/development/reference/python-sdk/platform/VersionInfo.mdx b/docs/development/reference/python-sdk/platform/VersionInfo.mdx new file mode 100644 index 0000000000..2d383e44a0 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/VersionInfo.mdx @@ -0,0 +1,23 @@ +--- +title: "VersionInfo" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VersionInfo +```python +from agentstack_sdk.platform import VersionInfo +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `docker` | `ResolvedDockerImageID \| None` | `None` | +| `github` | `ResolvedGithubUrl \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/get_platform_client.mdx b/docs/development/reference/python-sdk/platform/get_platform_client.mdx new file mode 100644 index 0000000000..2271e691de --- /dev/null +++ b/docs/development/reference/python-sdk/platform/get_platform_client.mdx @@ -0,0 +1,16 @@ +--- +title: "get_platform_client" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / get_platform_client +```python +from agentstack_sdk.platform import get_platform_client +``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/set_platform_client.mdx b/docs/development/reference/python-sdk/platform/set_platform_client.mdx new file mode 100644 index 0000000000..6249d3d290 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/set_platform_client.mdx @@ -0,0 +1,16 @@ +--- +title: "set_platform_client" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / set_platform_client +```python +from agentstack_sdk.platform import set_platform_client +``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/use_platform_client.mdx b/docs/development/reference/python-sdk/platform/use_platform_client.mdx new file mode 100644 index 0000000000..5ab4c19fd7 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/use_platform_client.mdx @@ -0,0 +1,16 @@ +--- +title: "use_platform_client" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / use_platform_client +```python +from agentstack_sdk.platform import use_platform_client +``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/uuid_to_str.mdx b/docs/development/reference/python-sdk/platform/uuid_to_str.mdx new file mode 100644 index 0000000000..de19267a4b --- /dev/null +++ b/docs/development/reference/python-sdk/platform/uuid_to_str.mdx @@ -0,0 +1,25 @@ +--- +title: "uuid_to_str" +description: "Convert UUID or str to str" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / uuid_to_str +```python +from agentstack_sdk.platform import uuid_to_str +``` +Convert UUID or str to str. +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `v` | `UUID | str` | — | | +## Returns + +`str` + diff --git a/docs/development/reference/python-sdk/platform/validate_metadata.mdx b/docs/development/reference/python-sdk/platform/validate_metadata.mdx new file mode 100644 index 0000000000..0f6cb78c48 --- /dev/null +++ b/docs/development/reference/python-sdk/platform/validate_metadata.mdx @@ -0,0 +1,24 @@ +--- +title: "validate_metadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / validate_metadata +```python +from agentstack_sdk.platform import validate_metadata +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `metadata` | `dict[str, str | None]` | — | | +## Returns + +`dict[str, str | None]` + diff --git a/docs/development/reference/python-sdk/server.mdx b/docs/development/reference/python-sdk/server.mdx new file mode 100644 index 0000000000..3b7837695c --- /dev/null +++ b/docs/development/reference/python-sdk/server.mdx @@ -0,0 +1,22 @@ +--- +title: "Server" +description: "Core server for creating and running A2A-compatible agents" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.server import Server +``` +--- +### Classes + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/Agent.mdx b/docs/development/reference/python-sdk/server/Agent.mdx new file mode 100644 index 0000000000..76ae2e8853 --- /dev/null +++ b/docs/development/reference/python-sdk/server/Agent.mdx @@ -0,0 +1,51 @@ +--- +title: "agent" +description: "Create an Agent function" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / agent +```python +from agentstack_sdk.server import agent +``` +Create an Agent function. + +:param name: A human-readable name for the agent (inferred from the function name if not provided). +:param description: A human-readable description of the agent, assisting users and other agents in understanding + its purpose (inferred from the function docstring if not provided). +:param additional_interfaces: A list of additional supported interfaces (transport and URL combinations). + A client can use any of these to communicate with the agent. +:param capabilities: A declaration of optional capabilities supported by the agent. +:param default_input_modes: Default set of supported input MIME types for all skills, which can be overridden on + a per-skill basis. +:param default_output_modes: Default set of supported output MIME types for all skills, which can be overridden on + a per-skill basis. +:param detail: Agent Stack SDK details extending the agent metadata +:param documentation_url: An optional URL to the agent's documentation. +:param extensions: Agent Stack SDK extensions to apply to the agent. +:param icon_url: An optional URL to an icon for the agent. +:param preferred_transport: The transport protocol for the preferred endpoint. Defaults to 'JSONRPC' if not + specified. +:param provider: Information about the agent's service provider. +:param security: A list of security requirement objects that apply to all agent interactions. Each object lists + security schemes that can be used. Follows the OpenAPI 3.0 Security Requirement Object. +:param security_schemes: A declaration of the security schemes available to authorize requests. The key is the + scheme name. Follows the OpenAPI 3.0 Security Scheme Object. +:param skills: The set of skills, or distinct capabilities, that the agent can perform. +:param supports_authenticated_extended_card: If true, the agent can provide an extended agent card with additional + details to authenticated users. Defaults to false. +:param version: The agent's own version number. The format is defined by the provider. +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `name` | `str | None` | — | || `description` | `str | None` | — | || `url` | `str` | `'http://invalid'` | || `additional_interfaces` | `list[AgentInterface] | None` | — | || `capabilities` | `AgentCapabilities | None` | — | || `default_input_modes` | `list[str] | None` | — | || `default_output_modes` | `list[str] | None` | — | || `detail` | `AgentDetail | None` | — | || `documentation_url` | `str | None` | — | || `icon_url` | `str | None` | — | || `preferred_transport` | `str | None` | — | || `provider` | `AgentProvider | None` | — | || `security` | `list[dict[str, list[str]]] | None` | — | || `security_schemes` | `dict[str, SecurityScheme] | None` | — | || `skills` | `list[AgentSkill] | None` | — | || `supports_authenticated_extended_card` | `bool | None` | — | || `version` | `str | None` | — | | +## Returns + +`Callable[[OriginalFnType], AgentFactory]` + diff --git a/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx b/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx new file mode 100644 index 0000000000..2cfa27813f --- /dev/null +++ b/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx @@ -0,0 +1,17 @@ +--- +title: "AgentExecuteFn" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / AgentExecuteFn +```python +from agentstack_sdk.server import AgentExecuteFn +``` +**Bases:** `Protocol` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/AgentRun.mdx b/docs/development/reference/python-sdk/server/AgentRun.mdx new file mode 100644 index 0000000000..bd0d65f16c --- /dev/null +++ b/docs/development/reference/python-sdk/server/AgentRun.mdx @@ -0,0 +1,69 @@ +--- +title: "AgentRun" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / AgentRun +```python +from agentstack_sdk.server import AgentRun +``` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `last_invocation` | `datetime` | `datetime.now()` | +| `resume_queue` | `asyncio.Queue[RunYieldResume]` | `asyncio.Queue()` | +| `run_context` | `RunContext` | — | +| `request_context` | `RequestContext` | — | +| `task_updater` | `TaskUpdater` | — | +| `done` | `bool` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent` | `Agent` | — | +| `context_store` | `ContextStore` | — | +| `on_finish` | `Callable[[], None] \| None` | — | + +**Returns:** `None` + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request_context` | `RequestContext` | — | +| `event_queue` | `EventQueue` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request_context` | `RequestContext` | — | +| `event_queue` | `EventQueue` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request_context` | `RequestContext` | — | +| `event_queue` | `EventQueue` | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/ContextStore.mdx b/docs/development/reference/python-sdk/server/ContextStore.mdx new file mode 100644 index 0000000000..338b08b277 --- /dev/null +++ b/docs/development/reference/python-sdk/server/ContextStore.mdx @@ -0,0 +1,44 @@ +--- +title: "ContextStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / ContextStore +```python +from agentstack_sdk.server import ContextStore +``` +**Bases:** `ABC` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `dependencies` | `dict[str, Depends]` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `initialized_dependencies` | `list[Dependency]` | — | + +**Returns:** `ContextStoreInstance` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx b/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx new file mode 100644 index 0000000000..4d460539d3 --- /dev/null +++ b/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx @@ -0,0 +1,53 @@ +--- +title: "ContextStoreInstance" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / ContextStoreInstance +```python +from agentstack_sdk.server import ContextStoreInstance +``` +**Bases:** `Protocol` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `load_history_items` | `bool` | `False` | + +**Returns:** `AsyncIterator[ContextHistoryItem | Message | Artifact]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/Depends.mdx b/docs/development/reference/python-sdk/server/Depends.mdx new file mode 100644 index 0000000000..42ef3f2a1b --- /dev/null +++ b/docs/development/reference/python-sdk/server/Depends.mdx @@ -0,0 +1,35 @@ +--- +title: "Depends" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Depends +```python +from agentstack_sdk.server import Depends +``` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `extension` | `BaseExtensionServer[Any, Any] \| None` | `None` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `dependency` | `Annotated[Dependency, Doc('\n A "dependable" callable (like a function).\n Don\'t call it directly, Agent Stack SDK will call it for you, just pass the object directly.\n ')]` | — | + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/Executor.mdx b/docs/development/reference/python-sdk/server/Executor.mdx new file mode 100644 index 0000000000..226575adbc --- /dev/null +++ b/docs/development/reference/python-sdk/server/Executor.mdx @@ -0,0 +1,59 @@ +--- +title: "Executor" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Executor +```python +from agentstack_sdk.server import Executor +``` +**Bases:** `AgentExecutor` +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent` | `Agent` | — | +| `queue_manager` | `QueueManager` | — | +| `context_store` | `ContextStore` | — | +| `task_timeout` | `timedelta` | — | +| `task_store` | `TaskStore` | — | + +**Returns:** `None` + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context` | `RequestContext` | — | +| `event_queue` | `EventQueue` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context` | `RequestContext` | — | +| `event_queue` | `EventQueue` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx b/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx new file mode 100644 index 0000000000..fce8c76fb7 --- /dev/null +++ b/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx @@ -0,0 +1,47 @@ +--- +title: "InMemoryContextStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / InMemoryContextStore +```python +from agentstack_sdk.server import InMemoryContextStore +``` +**Bases:** `ContextStore` +## Methods + + + + +Initialize in-memory context store with TTL cache. + +Args: + max_contexts: Maximum number of contexts to keep in memory + ttl_seconds: Time-to-live for context instances in seconds (default: 1 hour) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `max_contexts` | `int` | `1000` | +| `context_ttl` | `timedelta` | `timedelta(hours=1)` | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `initialized_dependencies` | `list[Dependency]` | — | + +**Returns:** `ContextStoreInstance` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx b/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx new file mode 100644 index 0000000000..271fe2ec37 --- /dev/null +++ b/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx @@ -0,0 +1,66 @@ +--- +title: "MemoryContextStoreInstance" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / MemoryContextStoreInstance +```python +from agentstack_sdk.server import MemoryContextStoreInstance +``` +**Bases:** `ContextStoreInstance` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context_id` | — | `context_id` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `load_history_items` | `bool` | `False` | + +**Returns:** `AsyncIterator[ContextHistoryItem | Message | Artifact]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx b/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx new file mode 100644 index 0000000000..b61e58de7f --- /dev/null +++ b/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx @@ -0,0 +1,61 @@ +--- +title: "PlatformAuthBackend" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformAuthBackend +```python +from agentstack_sdk.server import PlatformAuthBackend +``` +**Bases:** `SdkAuthenticationBackend` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `skip_audience_validation` | `bool` | — | +| `security` | `HTTPBearer` | `HTTPBearer(auto_error=False)` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `public_url` | `str \| None` | — | +| `skip_audience_validation` | `bool \| None` | — | + +**Returns:** `None` + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `conn` | `HTTPConnection` | — | + +**Returns:** `tuple[AuthCredentials, BaseUser] | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent_card` | `AgentCard` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx b/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx new file mode 100644 index 0000000000..766f5c216e --- /dev/null +++ b/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx @@ -0,0 +1,42 @@ +--- +title: "PlatformAuthenticatedUser" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformAuthenticatedUser +```python +from agentstack_sdk.server import PlatformAuthenticatedUser +``` +**Bases:** `User , BaseUser` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `claims` | `dict[str, JsonValue]` | `claims` | +| `auth_token` | `Secret[str]` | `Secret(auth_token)` | +| `is_authenticated` | `bool` | — | +| `user_name` | `str` | — | +| `display_name` | `str` | — | +| `identity` | `str` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `claims` | `dict[str, JsonValue]` | — | +| `auth_token` | `str` | — | + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/PlatformContextStore.mdx b/docs/development/reference/python-sdk/server/PlatformContextStore.mdx new file mode 100644 index 0000000000..97f94353a6 --- /dev/null +++ b/docs/development/reference/python-sdk/server/PlatformContextStore.mdx @@ -0,0 +1,44 @@ +--- +title: "PlatformContextStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformContextStore +```python +from agentstack_sdk.server import PlatformContextStore +``` +**Bases:** `ContextStore` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `dependencies` | `dict[str, Depends]` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `initialized_dependencies` | `list[Dependency]` | — | + +**Returns:** `ContextStoreInstance` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx b/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx new file mode 100644 index 0000000000..60231b878f --- /dev/null +++ b/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx @@ -0,0 +1,61 @@ +--- +title: "PlatformContextStoreInstance" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformContextStoreInstance +```python +from agentstack_sdk.server import PlatformContextStoreInstance +``` +**Bases:** `ContextStoreInstance` +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `platform_extension` | `PlatformApiExtensionServer` | — | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `load_history_items` | `bool` | `False` | + +**Returns:** `AsyncIterator[ContextHistoryItem | Message | Artifact]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/RunContext.mdx b/docs/development/reference/python-sdk/server/RunContext.mdx new file mode 100644 index 0000000000..2293590bca --- /dev/null +++ b/docs/development/reference/python-sdk/server/RunContext.mdx @@ -0,0 +1,84 @@ +--- +title: "RunContext" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / RunContext +```python +from agentstack_sdk.server import RunContext +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `configuration` | `MessageSendConfiguration \| None` | `None` | +| `task_id` | `str` | — | +| `context_id` | `str` | — | +| `current_task` | `Task \| None` | `None` | +| `related_tasks` | `list[Task] \| None` | `None` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `load_history_items` | `bool` | `False` | + +**Returns:** `AsyncGenerator[ContextHistoryItem | Message | Artifact]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `value` | `RunYield` | — | + +**Returns:** `RunYieldResume` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `value` | `RunYield` | — | + +**Returns:** `RunYieldResume` + + + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/Server.mdx b/docs/development/reference/python-sdk/server/Server.mdx new file mode 100644 index 0000000000..798c30dade --- /dev/null +++ b/docs/development/reference/python-sdk/server/Server.mdx @@ -0,0 +1,127 @@ +--- +title: "Server" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Server +```python +from agentstack_sdk.server import Server +``` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `server` | `uvicorn.Server \| None` | `None` | +| `should_exit` | `bool` | — | + +## Methods + + + + +**Returns:** `None` + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `args` | — | `()` | +| `kwargs` | — | `{}` | + +**Returns:** `Callable` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `configure_logger` | `bool` | `True` | +| `configure_telemetry` | `bool` | `False` | +| `self_registration` | `bool` | `True` | +| `self_registration_id` | `str \| None` | — | +| `task_store` | `TaskStore \| None` | — | +| `context_store` | `ContextStore \| None` | — | +| `queue_manager` | `QueueManager \| None` | — | +| `task_timeout` | `timedelta` | `timedelta(minutes=10)` | +| `push_config_store` | `PushNotificationConfigStore \| None` | — | +| `push_sender` | `PushNotificationSender \| None` | — | +| `request_context_builder` | `RequestContextBuilder \| None` | — | +| `host` | `str` | `'127.0.0.1'` | +| `port` | `int` | `10000` | +| `url` | `str \| None` | — | +| `uds` | `str \| None` | — | +| `fd` | `int \| None` | — | +| `loop` | `Literal['none', 'auto', 'asyncio', 'uvloop']` | `'auto'` | +| `http` | `type[asyncio.Protocol] \| uvicorn_config.HTTPProtocolType` | `'auto'` | +| `ws` | `type[asyncio.Protocol] \| uvicorn_config.WSProtocolType` | `'auto'` | +| `ws_max_size` | `int` | `16 * 1024 * 1024` | +| `ws_max_queue` | `int` | `32` | +| `ws_ping_interval` | `float \| None` | `20.0` | +| `ws_ping_timeout` | `float \| None` | `20.0` | +| `ws_per_message_deflate` | `bool` | `True` | +| `lifespan` | `uvicorn_config.LifespanType` | `'auto'` | +| `lifespan_fn` | `Lifespan[AppType] \| None` | — | +| `env_file` | `str \| os.PathLike[str] \| None` | — | +| `log_config` | `dict[str, Any] \| str \| RawConfigParser \| IO[Any] \| None` | `uvicorn_config.LOGGING_CONFIG` | +| `log_level` | `str \| int \| None` | — | +| `access_log` | `bool` | `True` | +| `use_colors` | `bool \| None` | — | +| `interface` | `uvicorn_config.InterfaceType` | `'auto'` | +| `reload` | `bool` | `False` | +| `reload_dirs` | `list[str] \| str \| None` | — | +| `reload_delay` | `float` | `0.25` | +| `reload_includes` | `list[str] \| str \| None` | — | +| `reload_excludes` | `list[str] \| str \| None` | — | +| `workers` | `int \| None` | — | +| `proxy_headers` | `bool` | `True` | +| `server_header` | `bool` | `True` | +| `date_header` | `bool` | `True` | +| `forwarded_allow_ips` | `list[str] \| str \| None` | — | +| `root_path` | `str` | `''` | +| `limit_concurrency` | `int \| None` | — | +| `limit_max_requests` | `int \| None` | — | +| `backlog` | `int` | `2048` | +| `timeout_keep_alive` | `int` | `5` | +| `timeout_notify` | `int` | `30` | +| `timeout_worker_healthcheck` | `int` | `5` | +| `timeout_graceful_shutdown` | `int \| None` | — | +| `callback_notify` | `Callable[..., Awaitable[None]] \| None` | — | +| `ssl_keyfile` | `str \| os.PathLike[str] \| None` | — | +| `ssl_certfile` | `str \| os.PathLike[str] \| None` | — | +| `ssl_keyfile_password` | `str \| None` | — | +| `ssl_version` | `int` | `uvicorn_config.SSL_PROTOCOL_VERSION` | +| `ssl_cert_reqs` | `int` | `CERT_NONE` | +| `ssl_ca_certs` | `str \| None` | — | +| `ssl_ciphers` | `str` | `'TLSv1'` | +| `headers` | `list[tuple[str, str]] \| None` | — | +| `factory` | `bool` | `False` | +| `h11_max_incomplete_event_size` | `int \| None` | — | +| `self_registration_client_factory` | `Callable[[], PlatformClient] \| None` | — | +| `auth_backend` | `SdkAuthenticationBackend \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `args` | — | `()` | +| `kwargs` | — | `{}` | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/cancel_task.mdx b/docs/development/reference/python-sdk/server/cancel_task.mdx new file mode 100644 index 0000000000..56a70a0983 --- /dev/null +++ b/docs/development/reference/python-sdk/server/cancel_task.mdx @@ -0,0 +1,21 @@ +--- +title: "cancel_task" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / cancel_task +```python +from agentstack_sdk.server import cancel_task +``` +Labels: `async` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `task` | `asyncio.Task` | — | | \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/close_queue.mdx b/docs/development/reference/python-sdk/server/close_queue.mdx new file mode 100644 index 0000000000..4facb8ea76 --- /dev/null +++ b/docs/development/reference/python-sdk/server/close_queue.mdx @@ -0,0 +1,26 @@ +--- +title: "close_queue" +description: "Closes a queue without blocking the QueueManager" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / close_queue +```python +from agentstack_sdk.server import close_queue +``` +Labels: `async` +Closes a queue without blocking the QueueManager + +By default, QueueManager.close() will block all QueueManager operations (creating new queues, etc) +until all queue events are processed. This can have unexpected side effects, we avoid this by closing queue +independently and then removing it from queue_manager +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `queue_manager` | `QueueManager` | — | || `queue_name` | `str` | — | || `immediate` | `bool` | `False` | | \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/configure_telemetry.mdx b/docs/development/reference/python-sdk/server/configure_telemetry.mdx new file mode 100644 index 0000000000..e6945e77ae --- /dev/null +++ b/docs/development/reference/python-sdk/server/configure_telemetry.mdx @@ -0,0 +1,25 @@ +--- +title: "configure_telemetry" +description: "Utility that configures opentelemetry with OTLP exporter and FastAPI instrumentation" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / configure_telemetry +```python +from agentstack_sdk.server import configure_telemetry +``` +Utility that configures opentelemetry with OTLP exporter and FastAPI instrumentation +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `app` | `FastAPI` | — | | +## Returns + +`None` + diff --git a/docs/development/reference/python-sdk/server/create_app.mdx b/docs/development/reference/python-sdk/server/create_app.mdx new file mode 100644 index 0000000000..127a8845d9 --- /dev/null +++ b/docs/development/reference/python-sdk/server/create_app.mdx @@ -0,0 +1,24 @@ +--- +title: "create_app" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / create_app +```python +from agentstack_sdk.server import create_app +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `agent` | `Agent` | — | || `task_store` | `TaskStore | None` | — | || `context_store` | `ContextStore | None` | — | || `queue_manager` | `QueueManager | None` | — | || `push_config_store` | `PushNotificationConfigStore | None` | — | || `push_sender` | `PushNotificationSender | None` | — | || `request_context_builder` | `RequestContextBuilder | None` | — | || `lifespan` | `Lifespan[AppType] | None` | — | || `dependencies` | `list[Depends] | None` | — | || `override_interfaces` | `bool` | `True` | || `task_timeout` | `timedelta` | `timedelta(minutes=10)` | || `kwargs` | — | `{}` | | +## Returns + +`FastAPI` + diff --git a/docs/development/reference/python-sdk/server/discover_jwks.mdx b/docs/development/reference/python-sdk/server/discover_jwks.mdx new file mode 100644 index 0000000000..ddf8990e40 --- /dev/null +++ b/docs/development/reference/python-sdk/server/discover_jwks.mdx @@ -0,0 +1,21 @@ +--- +title: "discover_jwks" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / discover_jwks +```python +from agentstack_sdk.server import discover_jwks +``` +Labels: `async` +## Returns + +`KeySet` + diff --git a/docs/development/reference/python-sdk/server/extract_dependencies.mdx b/docs/development/reference/python-sdk/server/extract_dependencies.mdx new file mode 100644 index 0000000000..8e87ce552b --- /dev/null +++ b/docs/development/reference/python-sdk/server/extract_dependencies.mdx @@ -0,0 +1,24 @@ +--- +title: "extract_dependencies" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / extract_dependencies +```python +from agentstack_sdk.server import extract_dependencies +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `fn` | `Callable[..., Any]` | — | | +## Returns + +`dict[str, Depends]` + diff --git a/docs/development/reference/python-sdk/types.mdx b/docs/development/reference/python-sdk/types.mdx new file mode 100644 index 0000000000..9621371619 --- /dev/null +++ b/docs/development/reference/python-sdk/types.mdx @@ -0,0 +1,28 @@ +--- +title: "SDK Types" +description: "Core type definitions and base classes" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.types import SdkAuthenticationBackend +``` +--- +### Classes + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `JsonDict` | *type_alias* | `dict[str, JsonValue]` | +| `JsonValue` | *type_alias* | `list['JsonValue'] \| dict[str, 'JsonValue'] \| str \| bool \| int \| float \| None` | diff --git a/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx b/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx new file mode 100644 index 0000000000..32706d2679 --- /dev/null +++ b/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx @@ -0,0 +1,33 @@ +--- +title: "SdkAuthenticationBackend" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [SDK Types](/development/reference/python-sdk/types) / SdkAuthenticationBackend +```python +from agentstack_sdk.types import SdkAuthenticationBackend +``` +**Bases:** `AuthenticationBackend , abc.ABC` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent_card` | `AgentCard` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util.mdx b/docs/development/reference/python-sdk/util.mdx new file mode 100644 index 0000000000..8c8b12fe35 --- /dev/null +++ b/docs/development/reference/python-sdk/util.mdx @@ -0,0 +1,22 @@ +--- +title: "Utilities" +description: "Utility helpers" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```python +from agentstack_sdk.util import resource_context +``` +--- +### Functions + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/BearerAuth.mdx b/docs/development/reference/python-sdk/util/BearerAuth.mdx new file mode 100644 index 0000000000..ec7005bfdd --- /dev/null +++ b/docs/development/reference/python-sdk/util/BearerAuth.mdx @@ -0,0 +1,50 @@ +--- +title: "BearerAuth" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / BearerAuth +```python +from agentstack_sdk.util import BearerAuth +``` +**Bases:** `Auth` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `token` | — | `token` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `token` | `str` | — | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request` | `Request` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `request` | `Request` | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/ColoredFormatter.mdx b/docs/development/reference/python-sdk/util/ColoredFormatter.mdx new file mode 100644 index 0000000000..5c25910245 --- /dev/null +++ b/docs/development/reference/python-sdk/util/ColoredFormatter.mdx @@ -0,0 +1,36 @@ +--- +title: "ColoredFormatter" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / ColoredFormatter +```python +from agentstack_sdk.util import ColoredFormatter +``` +**Bases:** `logging.Formatter` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `COLORS` | `dict[str, str]` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `record` | — | — | + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/LoadedFile.mdx b/docs/development/reference/python-sdk/util/LoadedFile.mdx new file mode 100644 index 0000000000..7efad70adc --- /dev/null +++ b/docs/development/reference/python-sdk/util/LoadedFile.mdx @@ -0,0 +1,100 @@ +--- +title: "LoadedFile" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / LoadedFile +```python +from agentstack_sdk.util import LoadedFile +``` +**Bases:** `Protocol` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `filename` | `str \| None` | — | +| `content_type` | `str` | — | +| `file_size_bytes` | `int \| None` | — | +| `content` | `bytes` | — | +| `text` | `str` | — | + +## Methods + + + + + + +Read and return the response content. +**Returns:** `bytes` + + + +A byte-iterator over the decoded response content. +This allows us to handle gzip, deflate, brotli, and zstd encoded responses. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `Iterator[bytes]` + + + +A str-iterator over the decoded response content +that handles both gzip, deflate, etc but also detects the content's +string encoding. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `Iterator[str]` + + + +**Returns:** `Iterator[str]` + + + +**Returns:** `bytes` + + + +A byte-iterator over the decoded response content. +This allows us to handle gzip, deflate, brotli, and zstd encoded responses. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `AsyncIterator[bytes]` + + + +A str-iterator over the decoded response content +that handles both gzip, deflate, etc but also detects the content's +string encoding. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `AsyncIterator[str]` + + + +**Returns:** `AsyncIterator[str]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx b/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx new file mode 100644 index 0000000000..40ee243499 --- /dev/null +++ b/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx @@ -0,0 +1,99 @@ +--- +title: "LoadedFileWithBytes" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / LoadedFileWithBytes +```python +from agentstack_sdk.util import LoadedFileWithBytes +``` +**Bases:** `LoadedFile` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `filename` | — | `filename` | +| `content_type` | — | `content_type or 'application/octet-strea...` | +| `file_size_bytes` | — | `len(content)` | +| `content` | `bytes` | — | +| `text` | `str` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `content` | `bytes` | — | +| `filename` | `str \| None` | — | +| `content_type` | `str \| None` | — | +| `encoding` | `str \| None` | — | + + + + +**Returns:** `bytes` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `Iterator[bytes]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `Iterator[str]` + + + +**Returns:** `Iterator[str]` + + + +**Returns:** `bytes` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `AsyncIterator[bytes]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `AsyncIterator[str]` + + + +**Returns:** `AsyncIterator[str]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx b/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx new file mode 100644 index 0000000000..d94fc2f597 --- /dev/null +++ b/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx @@ -0,0 +1,110 @@ +--- +title: "LoadedFileWithUri" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / LoadedFileWithUri +```python +from agentstack_sdk.util import LoadedFileWithUri +``` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `file_size_bytes` | — | `file_size_bytes or int(response.headers....` | +| `filename` | — | `filename or response_filename` | +| `content_type` | — | `content_type or response_content_type or...` | +| `content` | `bytes` | — | +| `text` | `str` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `response` | `Response` | — | +| `filename` | `str \| None` | — | +| `content_type` | `str \| None` | — | +| `file_size_bytes` | `int \| None` | — | + + + + +Read and return the response content. +**Returns:** `bytes` + + + +A byte-iterator over the decoded response content. +This allows us to handle gzip, deflate, brotli, and zstd encoded responses. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `Iterator[bytes]` + + + +A str-iterator over the decoded response content +that handles both gzip, deflate, etc but also detects the content's +string encoding. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `Iterator[str]` + + + +**Returns:** `Iterator[str]` + + + +Read and return the response content. +**Returns:** `bytes` + + + +A byte-iterator over the decoded response content. +This allows us to handle gzip, deflate, brotli, and zstd encoded responses. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `AsyncIterator[bytes]` + + + +A str-iterator over the decoded response content +that handles both gzip, deflate, etc but also detects the content's +string encoding. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `chunk_size` | `int \| None` | — | + +**Returns:** `AsyncIterator[str]` + + + +**Returns:** `AsyncIterator[str]` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx b/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx new file mode 100644 index 0000000000..fea00d6a6c --- /dev/null +++ b/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx @@ -0,0 +1,22 @@ +--- +title: "PlatformFileUrl" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / PlatformFileUrl +```python +from agentstack_sdk.util import PlatformFileUrl +``` +**Bases:** `AnyUrl` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `file_id` | `str` | — | diff --git a/docs/development/reference/python-sdk/util/SecureBaseModel.mdx b/docs/development/reference/python-sdk/util/SecureBaseModel.mdx new file mode 100644 index 0000000000..a22e6b4566 --- /dev/null +++ b/docs/development/reference/python-sdk/util/SecureBaseModel.mdx @@ -0,0 +1,18 @@ +--- +title: "SecureBaseModel" +description: "Base class that automatically handles SecretStr redaction unless explicitly revealed via context" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / SecureBaseModel +```python +from agentstack_sdk.util import SecureBaseModel +``` +**Bases:** `BaseModel` +Inherit from this instead of BaseModel for models that may contain secrets. \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx b/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx new file mode 100644 index 0000000000..9bffe49f79 --- /dev/null +++ b/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx @@ -0,0 +1,18 @@ +--- +title: "apply_compatibility_monkey_patching" +description: "Workaround for Pydantic + Python 3.14 issue where TypeAdapter[ChatModelKwargs] is not fully defined" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / apply_compatibility_monkey_patching +```python +from agentstack_sdk.util import apply_compatibility_monkey_patching +``` +Workaround for Pydantic + Python 3.14 issue where TypeAdapter[ChatModelKwargs] is not fully defined. +This happens because TypedDict annotations are deferred in 3.14 and Pydantic's lazy build fails to resolve them. \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/configure_logger.mdx b/docs/development/reference/python-sdk/util/configure_logger.mdx new file mode 100644 index 0000000000..b03abf50d5 --- /dev/null +++ b/docs/development/reference/python-sdk/util/configure_logger.mdx @@ -0,0 +1,24 @@ +--- +title: "configure_logger" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / configure_logger +```python +from agentstack_sdk.util import configure_logger +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `level` | `int | str | None` | — | | +## Returns + +`None` + diff --git a/docs/development/reference/python-sdk/util/extract_messages.mdx b/docs/development/reference/python-sdk/util/extract_messages.mdx new file mode 100644 index 0000000000..1e72c6a87a --- /dev/null +++ b/docs/development/reference/python-sdk/util/extract_messages.mdx @@ -0,0 +1,24 @@ +--- +title: "extract_messages" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / extract_messages +```python +from agentstack_sdk.util import extract_messages +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `exc` | `BaseException` | — | | +## Returns + +`list[tuple[str, str]]` + diff --git a/docs/development/reference/python-sdk/util/filter_dict.mdx b/docs/development/reference/python-sdk/util/filter_dict.mdx new file mode 100644 index 0000000000..d3276db242 --- /dev/null +++ b/docs/development/reference/python-sdk/util/filter_dict.mdx @@ -0,0 +1,20 @@ +--- +title: "filter_dict" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / filter_dict +```python +from agentstack_sdk.util import filter_dict +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `d` | `dict` | — | | \ No newline at end of file diff --git a/docs/development/reference/python-sdk/util/flatten_dict.mdx b/docs/development/reference/python-sdk/util/flatten_dict.mdx new file mode 100644 index 0000000000..521f4e6954 --- /dev/null +++ b/docs/development/reference/python-sdk/util/flatten_dict.mdx @@ -0,0 +1,28 @@ +--- +title: "flatten_dict" +description: "Flatten nested dict → OpenTelemetry-compatible flat dict" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / flatten_dict +```python +from agentstack_sdk.util import flatten_dict +``` +Flatten nested dict → OpenTelemetry-compatible flat dict. + +- Lists are usually kept as-is (OTel supports primitive arrays) +- None values are skipped by default +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `d` | `Mapping[str, Any]` | — | || `parent_key` | `str` | `''` | || `sep` | `str` | `'.'` | || `skip_none` | `bool` | `True` | || `max_depth` | `int | None` | — | | +## Returns + +`dict[str, Any]` + diff --git a/docs/development/reference/python-sdk/util/load_file.mdx b/docs/development/reference/python-sdk/util/load_file.mdx new file mode 100644 index 0000000000..c1b296178d --- /dev/null +++ b/docs/development/reference/python-sdk/util/load_file.mdx @@ -0,0 +1,27 @@ +--- +title: "load_file" +description: ":param stream: if stream is set to False, 'content' and 'text' fields are immediately available" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / load_file +```python +from agentstack_sdk.util import load_file +``` +Labels: `async` +:param stream: if stream is set to False, 'content' and 'text' fields are immediately available. + Otherwise, they are only available after calling the '(a)read' method. +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `part` | `FilePart` | — | || `stream` | `bool` | `False` | || `client` | `AsyncClient | None` | — | | +## Returns + +`AsyncIterator[LoadedFile]` + diff --git a/docs/development/reference/python-sdk/util/parse_stream.mdx b/docs/development/reference/python-sdk/util/parse_stream.mdx new file mode 100644 index 0000000000..74ad56e194 --- /dev/null +++ b/docs/development/reference/python-sdk/util/parse_stream.mdx @@ -0,0 +1,25 @@ +--- +title: "parse_stream" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / parse_stream +```python +from agentstack_sdk.util import parse_stream +``` +Labels: `async` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `response` | `Response` | — | | +## Returns + +`AsyncIterator[dict[str, Any]]` + diff --git a/docs/development/reference/python-sdk/util/redact_dict.mdx b/docs/development/reference/python-sdk/util/redact_dict.mdx new file mode 100644 index 0000000000..946f750fb9 --- /dev/null +++ b/docs/development/reference/python-sdk/util/redact_dict.mdx @@ -0,0 +1,24 @@ +--- +title: "redact_dict" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_dict +```python +from agentstack_sdk.util import redact_dict +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `v` | `dict[str, str]` | — | || `info` | `SerializationInfo` | — | | +## Returns + +`dict[str, str]` + diff --git a/docs/development/reference/python-sdk/util/redact_secret.mdx b/docs/development/reference/python-sdk/util/redact_secret.mdx new file mode 100644 index 0000000000..12723cf482 --- /dev/null +++ b/docs/development/reference/python-sdk/util/redact_secret.mdx @@ -0,0 +1,24 @@ +--- +title: "redact_secret" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_secret +```python +from agentstack_sdk.util import redact_secret +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `v` | `Secret | SecretStr | SecretBytes` | — | || `info` | `SerializationInfo` | — | | +## Returns + +`Secret | SecretStr | SecretBytes | str | bytes` + diff --git a/docs/development/reference/python-sdk/util/redact_str.mdx b/docs/development/reference/python-sdk/util/redact_str.mdx new file mode 100644 index 0000000000..5c067582ca --- /dev/null +++ b/docs/development/reference/python-sdk/util/redact_str.mdx @@ -0,0 +1,24 @@ +--- +title: "redact_str" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_str +```python +from agentstack_sdk.util import redact_str +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `v` | `str` | — | || `info` | `SerializationInfo` | — | | +## Returns + +`str` + diff --git a/docs/development/reference/python-sdk/util/redact_url.mdx b/docs/development/reference/python-sdk/util/redact_url.mdx new file mode 100644 index 0000000000..6154be8167 --- /dev/null +++ b/docs/development/reference/python-sdk/util/redact_url.mdx @@ -0,0 +1,24 @@ +--- +title: "redact_url" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_url +```python +from agentstack_sdk.util import redact_url +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `v` | `AnyUrl` | — | || `info` | `SerializationInfo` | — | | +## Returns + +`AnyUrl` + diff --git a/docs/development/reference/python-sdk/util/resource_context.mdx b/docs/development/reference/python-sdk/util/resource_context.mdx new file mode 100644 index 0000000000..401fe239f4 --- /dev/null +++ b/docs/development/reference/python-sdk/util/resource_context.mdx @@ -0,0 +1,24 @@ +--- +title: "resource_context" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / resource_context +```python +from agentstack_sdk.util import resource_context +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `factory` | `Callable[P, T]` | — | || `default_factory` | `Callable[[], T]` | — | | +## Returns + +`tuple[typing.Callable[[], T], typing.Callable[P, contextlib.AbstractContextManager[T]]]` + diff --git a/docs/development/reference/python-sdk/util/should_redact.mdx b/docs/development/reference/python-sdk/util/should_redact.mdx new file mode 100644 index 0000000000..4fc8baec00 --- /dev/null +++ b/docs/development/reference/python-sdk/util/should_redact.mdx @@ -0,0 +1,24 @@ +--- +title: "should_redact" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / should_redact +```python +from agentstack_sdk.util import should_redact +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `info` | `SerializationInfo` | — | | +## Returns + +`bool` + diff --git a/docs/development/reference/python-sdk/util/should_reveal.mdx b/docs/development/reference/python-sdk/util/should_reveal.mdx new file mode 100644 index 0000000000..6864bf59a4 --- /dev/null +++ b/docs/development/reference/python-sdk/util/should_reveal.mdx @@ -0,0 +1,24 @@ +--- +title: "should_reveal" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / should_reveal +```python +from agentstack_sdk.util import should_reveal +``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `info` | `SerializationInfo` | — | | +## Returns + +`bool` + diff --git a/docs/development/reference/python-sdk/util/trace_class.mdx b/docs/development/reference/python-sdk/util/trace_class.mdx new file mode 100644 index 0000000000..28e86957ac --- /dev/null +++ b/docs/development/reference/python-sdk/util/trace_class.mdx @@ -0,0 +1,72 @@ +--- +title: "trace_class" +description: "A class decorator to automatically trace specified methods of a class" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / trace_class +```python +from agentstack_sdk.util import trace_class +``` +A class decorator to automatically trace specified methods of a class. + +This decorator iterates over the methods of a class and applies the +`trace_function` decorator to them, based on the `include_list` and +`exclude_list` criteria. Methods starting or ending with double underscores +(dunder methods, e.g., `__init__`, `__call__`) are always excluded by default. + +Args: + include_list (list[str], optional): A list of method names to + explicitly include for tracing. If provided, only methods in this + list (that are not dunder methods) will be traced. + Defaults to None (trace all non-dunder methods). + exclude_list (list[str], optional): A list of method names to exclude + from tracing. This is only considered if `include_list` is not + provided. Dunder methods are implicitly excluded. + Defaults to an empty list. + kind (SpanKind, optional): The `opentelemetry.trace.SpanKind` for the + created spans on the methods. Defaults to `SpanKind.INTERNAL`. + +Returns: + callable: A decorator function that, when applied to a class, + modifies the class to wrap its specified methods with tracing. + +Example: + To trace all methods except 'internal_method': + ```python + @trace_class(exclude_list=['internal_method']) + class MyService: + def public_api(self): + pass + + def internal_method(self): + pass + ``` + + To trace only 'method_one' and 'method_two': + ```python + @trace_class(include_list=['method_one', 'method_two']) + class AnotherService: + def method_one(self): + pass + + def method_two(self): + pass + + def not_traced_method(self): + pass + ``` +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `include_list` | `list[str] | None` | — | || `exclude_list` | `list[str] | None` | — | || `kind` | `SpanKind` | `SpanKind.INTERNAL` | || `attributes` | `dict[str, Any] | None` | — | | +## Returns + +`Callable` + diff --git a/docs/development/reference/python-sdk/util/trace_function.mdx b/docs/development/reference/python-sdk/util/trace_function.mdx new file mode 100644 index 0000000000..835671a1dd --- /dev/null +++ b/docs/development/reference/python-sdk/util/trace_function.mdx @@ -0,0 +1,66 @@ +--- +title: "trace_function" +description: "A decorator to automatically trace a function call with OpenTelemetry" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / trace_function +```python +from agentstack_sdk.util import trace_function +``` +A decorator to automatically trace a function call with OpenTelemetry. + +This decorator can be used to wrap both sync and async functions. +When applied, it creates a new span for each call to the decorated function. +The span will record the execution time, status (OK or ERROR), and any +exceptions that occur. + +It can be used in two ways: + +1. As a direct decorator: `@trace_function` +2. As a decorator factory to provide arguments: `@trace_function(span_name="custom.name")` + +Args: + func (callable, optional): The function to be decorated. If None, + the decorator returns a partial function, allowing it to be called + with arguments. Defaults to None. + span_name (str, optional): Custom name for the span. If None, + it defaults to ``f'{func.__module__}.{func.__name__}'``. + Defaults to None. + kind (SpanKind, optional): The ``opentelemetry.trace.SpanKind`` for the + created span. Defaults to ``SpanKind.INTERNAL``. + attributes (dict, optional): A dictionary of static attributes to be + set on the span. Keys are attribute names (str) and values are + the corresponding attribute values. Defaults to None. + attribute_extractor (callable, optional): A function that can be used + to dynamically extract and set attributes on the span. + It is called within a ``finally`` block, ensuring it runs even if + the decorated function raises an exception. + The function signature should be: + ``attribute_extractor(span, args, kwargs, result, exception)`` + where: + - ``span`` : the OpenTelemetry ``Span`` object. + - ``args`` : a tuple of positional arguments passed + - ``kwargs`` : a dictionary of keyword arguments passed + - ``result`` : return value (None if an exception occurred) + - ``exception`` : exception object if raised (None otherwise). + Any exception raised by the ``attribute_extractor`` itself will be + caught and logged. Defaults to None. + +Returns: + callable: The wrapped function that includes tracing, or a partial + decorator if ``func`` is None. +## Parameters + +| Name | Type | Default | Description | +|------|------|---------|-------------|| `func` | `Callable | None` | — | || `span_name` | `str | None` | — | || `kind` | `SpanKind` | `SpanKind.INTERNAL` | || `attributes` | `dict[str, Any] | None` | — | || `attribute_extractor` | `Callable | None` | — | | +## Returns + +`Callable` + diff --git a/docs/development/reference/python-sdk/util/utc_now.mdx b/docs/development/reference/python-sdk/util/utc_now.mdx new file mode 100644 index 0000000000..b6ec652afc --- /dev/null +++ b/docs/development/reference/python-sdk/util/utc_now.mdx @@ -0,0 +1,20 @@ +--- +title: "utc_now" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / utc_now +```python +from agentstack_sdk.util import utc_now +``` +## Returns + +`datetime` + diff --git a/docs/docs.json b/docs/docs.json index ec71654df5..6ef6626196 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -57,7 +57,9 @@ }, { "group": "Reference", - "pages": ["stable/reference/cli-reference"] + "pages": [ + "stable/reference/cli-reference" + ] }, { "group": "Deploy Agent Stack", @@ -134,7 +136,44 @@ }, { "group": "Reference", - "pages": ["development/reference/cli-reference"] + "pages": [ + "development/reference/cli-reference", + { + "group": "Python SDK", + "pages": [ + "development/reference/python-sdk/overview", + { + "group": "Server", + "pages": [ + "development/reference/python-sdk/server" + ] + }, + { + "group": "A2A Extensions", + "pages": [ + "development/reference/python-sdk/a2a", + "development/reference/python-sdk/a2a-common", + "development/reference/python-sdk/a2a-interactions", + "development/reference/python-sdk/a2a-services", + "development/reference/python-sdk/a2a-tools", + "development/reference/python-sdk/a2a-ui", + { + "group": "Auth", + "pages": [ + "development/reference/python-sdk/a2a-auth", + "development/reference/python-sdk/a2a-auth-oauth", + "development/reference/python-sdk/a2a-auth-oauth-storage", + "development/reference/python-sdk/a2a-auth-secrets" + ] + } + ] + }, + "development/reference/python-sdk/platform", + "development/reference/python-sdk/types", + "development/reference/python-sdk/util" + ] + } + ] }, { "group": "Deploy Agent Stack", From f42283de98320b564ffbfa8005a777a43dd7a3ff Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Tue, 3 Mar 2026 19:46:17 +0100 Subject: [PATCH 2/8] license Signed-off-by: Jan Jeliga --- apps/agentstack-sdk-py/docs/generate_docs.py | 1 - apps/agentstack-sdk-py/docs/introspect_exports.py | 8 ++------ 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py index 048809354f..10bdd55d90 100644 --- a/apps/agentstack-sdk-py/docs/generate_docs.py +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python3 # Copyright 2025 © BeeAI a Series of LF Projects, LLC # SPDX-License-Identifier: Apache-2.0 """Generate Python SDK reference docs (MDX) from exports_structure.json. diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py index 06e80b20dc..385bef49df 100644 --- a/apps/agentstack-sdk-py/docs/introspect_exports.py +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -1,8 +1,5 @@ -#!/usr/bin/env python -""" -Trace the public API of agentstack-sdk-py by following star-import chains, -then enrich each discovered name with griffe metadata. -""" +# Copyright 2025 © BeeAI a Series of LF Projects, LLC +# SPDX-License-Identifier: Apache-2.0 from __future__ import annotations @@ -25,7 +22,6 @@ class ExportItem(BaseModel): model_config = ConfigDict(validate_assignment=True) - name: str origin: str kind: str | None = None From 7bb129861e90554cc743dc7ff4e886b71c04171b Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Wed, 4 Mar 2026 08:09:03 +0100 Subject: [PATCH 3/8] fixed py checks and platform structure Signed-off-by: Jan Jeliga --- apps/agentstack-sdk-py/docs/generate_docs.py | 52 +++++++++++++------ .../docs/introspect_exports.py | 10 +--- .../docs/templates/class.mdx.j2 | 2 +- .../docs/templates/function.mdx.j2 | 11 ++-- .../docs/templates/module.mdx.j2 | 6 +-- apps/agentstack-sdk-py/tasks.toml | 2 +- .../python-sdk/a2a-auth-oauth-storage.mdx | 2 +- .../MemoryTokenStorage.mdx | 4 +- .../MemoryTokenStorageFactory.mdx | 4 +- .../TokenStorageFactory.mdx | 4 +- .../reference/python-sdk/a2a-auth-oauth.mdx | 7 +-- .../python-sdk/a2a-auth-oauth/AuthRequest.mdx | 2 +- .../a2a-auth-oauth/AuthResponse.mdx | 2 +- .../python-sdk/a2a-auth-oauth/OAuthDemand.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionClient.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionMetadata.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionParams.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionServer.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionSpec.mdx | 2 +- .../a2a-auth-oauth/OAuthFulfillment.mdx | 2 +- .../reference/python-sdk/a2a-auth-secrets.mdx | 2 +- .../a2a-auth-secrets/SecretDemand.mdx | 2 +- .../a2a-auth-secrets/SecretFulfillment.mdx | 2 +- .../SecretsExtensionClient.mdx | 2 +- .../SecretsExtensionServer.mdx | 2 +- .../a2a-auth-secrets/SecretsExtensionSpec.mdx | 2 +- .../SecretsServiceExtensionMetadata.mdx | 2 +- .../SecretsServiceExtensionParams.mdx | 2 +- .../reference/python-sdk/a2a-auth.mdx | 5 +- .../reference/python-sdk/a2a-common.mdx | 2 +- .../python-sdk/a2a-common/BaseField.mdx | 2 +- .../python-sdk/a2a-common/BaseFormRender.mdx | 2 +- .../a2a-common/BaseFormResponse.mdx | 2 +- .../python-sdk/a2a-common/CheckboxField.mdx | 2 +- .../a2a-common/CheckboxFieldValue.mdx | 2 +- .../a2a-common/CheckboxGroupField.mdx | 2 +- .../a2a-common/CheckboxGroupFieldValue.mdx | 2 +- .../python-sdk/a2a-common/DateField.mdx | 2 +- .../python-sdk/a2a-common/DateFieldValue.mdx | 2 +- .../python-sdk/a2a-common/FileField.mdx | 2 +- .../python-sdk/a2a-common/FileFieldValue.mdx | 2 +- .../python-sdk/a2a-common/FileInfo.mdx | 2 +- .../python-sdk/a2a-common/FileItem.mdx | 2 +- .../python-sdk/a2a-common/FormRender.mdx | 2 +- .../python-sdk/a2a-common/FormResponse.mdx | 2 +- .../a2a-common/MultiSelectField.mdx | 2 +- .../a2a-common/MultiSelectFieldValue.mdx | 2 +- .../python-sdk/a2a-common/OptionItem.mdx | 2 +- .../a2a-common/SettingsFormRender.mdx | 2 +- .../a2a-common/SettingsFormResponse.mdx | 2 +- .../a2a-common/SingleSelectField.mdx | 2 +- .../a2a-common/SingleSelectFieldValue.mdx | 2 +- .../python-sdk/a2a-common/TextField.mdx | 2 +- .../python-sdk/a2a-common/TextFieldValue.mdx | 2 +- .../BaseExtensionClient.mdx | 2 +- .../BaseExtensionServer.mdx | 2 +- .../a2a-extensions-base/BaseExtensionSpec.mdx | 2 +- .../NoParamsBaseExtensionSpec.mdx | 2 +- .../ExtensionError.mdx | 2 +- .../reference/python-sdk/a2a-interactions.mdx | 2 +- .../ApprovalExtensionClient.mdx | 2 +- .../ApprovalExtensionMetadata.mdx | 2 +- .../ApprovalExtensionParams.mdx | 2 +- .../ApprovalExtensionServer.mdx | 2 +- .../ApprovalExtensionSpec.mdx | 2 +- .../ApprovalRejectionError.mdx | 2 +- .../a2a-interactions/ApprovalResponse.mdx | 2 +- .../GenericApprovalRequest.mdx | 2 +- .../ToolCallApprovalRequest.mdx | 2 +- .../a2a-interactions/ToolCallServer.mdx | 2 +- .../reference/python-sdk/a2a-services.mdx | 2 +- .../a2a-services/EmbeddingDemand.mdx | 2 +- .../a2a-services/EmbeddingFulfillment.mdx | 2 +- .../EmbeddingServiceExtensionClient.mdx | 2 +- .../EmbeddingServiceExtensionMetadata.mdx | 2 +- .../EmbeddingServiceExtensionParams.mdx | 2 +- .../EmbeddingServiceExtensionServer.mdx | 2 +- .../EmbeddingServiceExtensionSpec.mdx | 2 +- .../python-sdk/a2a-services/FormDemands.mdx | 2 +- .../FormServiceExtensionClient.mdx | 2 +- .../FormServiceExtensionMetadata.mdx | 2 +- .../FormServiceExtensionParams.mdx | 2 +- .../FormServiceExtensionServer.mdx | 2 +- .../a2a-services/FormServiceExtensionSpec.mdx | 2 +- .../python-sdk/a2a-services/LLMDemand.mdx | 2 +- .../a2a-services/LLMFulfillment.mdx | 2 +- .../LLMServiceExtensionClient.mdx | 2 +- .../LLMServiceExtensionMetadata.mdx | 2 +- .../LLMServiceExtensionParams.mdx | 2 +- .../LLMServiceExtensionServer.mdx | 2 +- .../a2a-services/LLMServiceExtensionSpec.mdx | 2 +- .../python-sdk/a2a-services/MCPDemand.mdx | 2 +- .../a2a-services/MCPFulfillment.mdx | 2 +- .../MCPServiceExtensionClient.mdx | 2 +- .../MCPServiceExtensionMetadata.mdx | 2 +- .../MCPServiceExtensionParams.mdx | 2 +- .../MCPServiceExtensionServer.mdx | 2 +- .../a2a-services/MCPServiceExtensionSpec.mdx | 2 +- .../a2a-services/PlatformApiExtension.mdx | 2 +- .../PlatformApiExtensionClient.mdx | 2 +- .../PlatformApiExtensionMetadata.mdx | 2 +- .../PlatformApiExtensionParams.mdx | 2 +- .../PlatformApiExtensionServer.mdx | 2 +- .../a2a-services/PlatformApiExtensionSpec.mdx | 2 +- .../a2a-services/StdioTransport.mdx | 2 +- .../a2a-services/StreamableHTTPTransport.mdx | 2 +- .../reference/python-sdk/a2a-tools.mdx | 2 +- .../a2a-tools/ToolCallExtensionClient.mdx | 2 +- .../a2a-tools/ToolCallExtensionMetadata.mdx | 2 +- .../a2a-tools/ToolCallExtensionParams.mdx | 2 +- .../a2a-tools/ToolCallExtensionServer.mdx | 2 +- .../a2a-tools/ToolCallExtensionSpec.mdx | 2 +- .../a2a-tools/ToolCallRejectionError.mdx | 2 +- .../python-sdk/a2a-tools/ToolCallRequest.mdx | 2 +- .../python-sdk/a2a-tools/ToolCallResponse.mdx | 2 +- .../python-sdk/a2a-tools/ToolCallServer.mdx | 2 +- .../python-sdk/a2a-types/AgentArtifact.mdx | 2 +- .../python-sdk/a2a-types/AgentMessage.mdx | 2 +- .../python-sdk/a2a-types/ArtifactChunk.mdx | 2 +- .../python-sdk/a2a-types/AuthRequired.mdx | 2 +- .../python-sdk/a2a-types/InputRequired.mdx | 2 +- .../python-sdk/a2a-types/Metadata.mdx | 2 +- .../reference/python-sdk/a2a-ui.mdx | 2 +- .../python-sdk/a2a-ui/AgentDetail.mdx | 2 +- .../a2a-ui/AgentDetailContributor.mdx | 2 +- .../a2a-ui/AgentDetailExtensionClient.mdx | 2 +- .../a2a-ui/AgentDetailExtensionServer.mdx | 2 +- .../a2a-ui/AgentDetailExtensionSpec.mdx | 2 +- .../python-sdk/a2a-ui/AgentDetailTool.mdx | 2 +- .../python-sdk/a2a-ui/AgentRunSettings.mdx | 2 +- .../python-sdk/a2a-ui/CanvasEditRequest.mdx | 2 +- .../a2a-ui/CanvasEditRequestMetadata.mdx | 2 +- .../a2a-ui/CanvasExtensionServer.mdx | 2 +- .../python-sdk/a2a-ui/CanvasExtensionSpec.mdx | 2 +- .../python-sdk/a2a-ui/CheckboxField.mdx | 2 +- .../python-sdk/a2a-ui/CheckboxFieldValue.mdx | 2 +- .../python-sdk/a2a-ui/CheckboxGroupField.mdx | 2 +- .../a2a-ui/CheckboxGroupFieldValue.mdx | 2 +- .../reference/python-sdk/a2a-ui/Citation.mdx | 2 +- .../a2a-ui/CitationExtensionClient.mdx | 2 +- .../a2a-ui/CitationExtensionServer.mdx | 2 +- .../a2a-ui/CitationExtensionSpec.mdx | 2 +- .../python-sdk/a2a-ui/CitationMetadata.mdx | 2 +- .../reference/python-sdk/a2a-ui/EnvVar.mdx | 2 +- .../reference/python-sdk/a2a-ui/Error.mdx | 2 +- .../python-sdk/a2a-ui/ErrorContext.mdx | 2 +- .../a2a-ui/ErrorExtensionClient.mdx | 2 +- .../a2a-ui/ErrorExtensionParams.mdx | 2 +- .../a2a-ui/ErrorExtensionServer.mdx | 2 +- .../python-sdk/a2a-ui/ErrorExtensionSpec.mdx | 2 +- .../python-sdk/a2a-ui/ErrorGroup.mdx | 2 +- .../python-sdk/a2a-ui/ErrorMetadata.mdx | 2 +- .../a2a-ui/FormRequestExtensionClient.mdx | 2 +- .../a2a-ui/FormRequestExtensionServer.mdx | 2 +- .../a2a-ui/FormRequestExtensionSpec.mdx | 2 +- .../python-sdk/a2a-ui/OptionItem.mdx | 2 +- .../a2a-ui/SettingsExtensionClient.mdx | 2 +- .../a2a-ui/SettingsExtensionServer.mdx | 2 +- .../a2a-ui/SettingsExtensionSpec.mdx | 2 +- .../python-sdk/a2a-ui/SettingsRender.mdx | 2 +- .../python-sdk/a2a-ui/SingleSelectField.mdx | 2 +- .../a2a-ui/SingleSelectFieldValue.mdx | 2 +- .../python-sdk/a2a-ui/Trajectory.mdx | 2 +- .../a2a-ui/TrajectoryExtensionClient.mdx | 2 +- .../a2a-ui/TrajectoryExtensionServer.mdx | 2 +- .../a2a-ui/TrajectoryExtensionSpec.mdx | 2 +- .../reference/python-sdk/platform-common.mdx | 28 ++++++++++ .../GithubVersionType.mdx | 6 +-- .../PaginatedResult.mdx | 6 +-- .../ResolvedDockerImageID.mdx | 6 +-- .../ResolvedGithubUrl.mdx | 6 +-- .../reference/python-sdk/platform-context.mdx | 30 +++++++++++ .../Context.mdx | 6 +-- .../ContextHistoryItem.mdx | 6 +-- .../ContextPermissions.mdx | 6 +-- .../ContextToken.mdx | 6 +-- .../Permissions.mdx | 6 +-- .../reference/python-sdk/platform-idx.mdx | 23 ++++++++ .../reference/python-sdk/platform.mdx | 48 +---------------- .../python-sdk/platform/AddProvider.mdx | 4 +- .../platform/AuthorizationCodeRequest.mdx | 4 +- .../platform/BuildConfiguration.mdx | 4 +- .../python-sdk/platform/BuildState.mdx | 4 +- .../platform/ChangeRoleResponse.mdx | 4 +- .../python-sdk/platform/Connector.mdx | 4 +- .../python-sdk/platform/ConnectorPreset.mdx | 4 +- .../python-sdk/platform/ConnectorState.mdx | 4 +- .../python-sdk/platform/DiscoveryState.mdx | 4 +- .../reference/python-sdk/platform/EnvVar.mdx | 4 +- .../python-sdk/platform/ExtractedFileInfo.mdx | 4 +- .../python-sdk/platform/Extraction.mdx | 4 +- .../reference/python-sdk/platform/File.mdx | 4 +- .../platform/ListUserFeedbackResponse.mdx | 4 +- .../python-sdk/platform/MCPProxyResponse.mdx | 4 +- .../python-sdk/platform/ModelCapability.mdx | 4 +- .../python-sdk/platform/ModelProvider.mdx | 4 +- .../platform/ModelProviderState.mdx | 4 +- .../python-sdk/platform/ModelProviderType.mdx | 4 +- .../python-sdk/platform/ModelWithScore.mdx | 4 +- .../python-sdk/platform/NoAction.mdx | 4 +- .../python-sdk/platform/PlatformClient.mdx | 4 +- .../python-sdk/platform/Provider.mdx | 4 +- .../python-sdk/platform/ProviderBuild.mdx | 4 +- .../python-sdk/platform/ProviderDiscovery.mdx | 4 +- .../platform/ProviderErrorMessage.mdx | 4 +- .../platform/SystemConfiguration.mdx | 4 +- .../python-sdk/platform/UpdateProvider.mdx | 4 +- .../reference/python-sdk/platform/User.mdx | 4 +- .../python-sdk/platform/UserFeedback.mdx | 4 +- .../python-sdk/platform/UserRole.mdx | 4 +- .../python-sdk/platform/Variables.mdx | 4 +- .../python-sdk/platform/VectorStore.mdx | 4 +- .../platform/VectorStoreDocument.mdx | 4 +- .../python-sdk/platform/VectorStoreItem.mdx | 4 +- .../platform/VectorStoreSearchResult.mdx | 4 +- .../python-sdk/platform/VectorStoreStats.mdx | 4 +- .../python-sdk/platform/VersionInfo.mdx | 4 +- .../platform/get_platform_client.mdx | 4 +- .../platform/set_platform_client.mdx | 4 +- .../platform/use_platform_client.mdx | 4 +- .../python-sdk/platform/uuid_to_str.mdx | 10 ++-- .../python-sdk/platform/validate_metadata.mdx | 10 ++-- .../reference/python-sdk/server.mdx | 2 +- .../reference/python-sdk/server/Agent.mdx | 24 +++++++-- .../python-sdk/server/AgentExecuteFn.mdx | 2 +- .../reference/python-sdk/server/AgentRun.mdx | 2 +- .../python-sdk/server/ContextStore.mdx | 2 +- .../server/ContextStoreInstance.mdx | 2 +- .../reference/python-sdk/server/Depends.mdx | 2 +- .../reference/python-sdk/server/Executor.mdx | 2 +- .../server/InMemoryContextStore.mdx | 2 +- .../server/MemoryContextStoreInstance.mdx | 2 +- .../python-sdk/server/PlatformAuthBackend.mdx | 2 +- .../server/PlatformAuthenticatedUser.mdx | 2 +- .../server/PlatformContextStore.mdx | 2 +- .../server/PlatformContextStoreInstance.mdx | 2 +- .../python-sdk/server/RunContext.mdx | 2 +- .../reference/python-sdk/server/Server.mdx | 2 +- .../python-sdk/server/cancel_task.mdx | 7 +-- .../python-sdk/server/close_queue.mdx | 9 ++-- .../python-sdk/server/configure_telemetry.mdx | 8 +-- .../python-sdk/server/create_app.mdx | 19 +++++-- .../python-sdk/server/discover_jwks.mdx | 2 +- .../server/extract_dependencies.mdx | 8 +-- .../reference/python-sdk/types.mdx | 2 +- .../types/SdkAuthenticationBackend.mdx | 2 +- .../development/reference/python-sdk/util.mdx | 2 +- .../reference/python-sdk/util/BearerAuth.mdx | 2 +- .../python-sdk/util/ColoredFormatter.mdx | 2 +- .../reference/python-sdk/util/LoadedFile.mdx | 2 +- .../python-sdk/util/LoadedFileWithBytes.mdx | 2 +- .../python-sdk/util/LoadedFileWithUri.mdx | 2 +- .../python-sdk/util/PlatformFileUrl.mdx | 2 +- .../python-sdk/util/SecureBaseModel.mdx | 2 +- .../apply_compatibility_monkey_patching.mdx | 2 +- .../python-sdk/util/configure_logger.mdx | 8 +-- .../python-sdk/util/extract_messages.mdx | 8 +-- .../reference/python-sdk/util/filter_dict.mdx | 7 +-- .../python-sdk/util/flatten_dict.mdx | 12 +++-- .../reference/python-sdk/util/load_file.mdx | 10 ++-- .../python-sdk/util/parse_stream.mdx | 8 +-- .../reference/python-sdk/util/redact_dict.mdx | 9 ++-- .../python-sdk/util/redact_secret.mdx | 9 ++-- .../reference/python-sdk/util/redact_str.mdx | 9 ++-- .../reference/python-sdk/util/redact_url.mdx | 9 ++-- .../python-sdk/util/resource_context.mdx | 9 ++-- .../python-sdk/util/should_redact.mdx | 8 +-- .../python-sdk/util/should_reveal.mdx | 8 +-- .../reference/python-sdk/util/trace_class.mdx | 11 ++-- .../python-sdk/util/trace_function.mdx | 12 +++-- .../reference/python-sdk/util/utc_now.mdx | 2 +- docs/docs.json | 10 +++- 272 files changed, 601 insertions(+), 461 deletions(-) create mode 100644 docs/development/reference/python-sdk/platform-common.mdx rename docs/development/reference/python-sdk/{platform => platform-common}/GithubVersionType.mdx (65%) rename docs/development/reference/python-sdk/{platform => platform-common}/PaginatedResult.mdx (70%) rename docs/development/reference/python-sdk/{platform => platform-common}/ResolvedDockerImageID.mdx (67%) rename docs/development/reference/python-sdk/{platform => platform-common}/ResolvedGithubUrl.mdx (72%) create mode 100644 docs/development/reference/python-sdk/platform-context.mdx rename docs/development/reference/python-sdk/{platform => platform-context}/Context.mdx (95%) rename docs/development/reference/python-sdk/{platform => platform-context}/ContextHistoryItem.mdx (72%) rename docs/development/reference/python-sdk/{platform => platform-context}/ContextPermissions.mdx (71%) rename docs/development/reference/python-sdk/{platform => platform-context}/ContextToken.mdx (68%) rename docs/development/reference/python-sdk/{platform => platform-context}/Permissions.mdx (81%) create mode 100644 docs/development/reference/python-sdk/platform-idx.mdx diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py index 10bdd55d90..f9349fbdba 100644 --- a/apps/agentstack-sdk-py/docs/generate_docs.py +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -106,7 +106,8 @@ "description": "OAuth and secrets authentication extensions", "import_path": "agentstack_sdk.a2a.extensions.auth", "submodule_cards": [ - {"title": "OAuth", "filename": "a2a-auth-oauth", "description": "OAuth 2.0 flow extensions"}, + {"title": "Extensions", "filename": "a2a-auth-oauth", "description": "OAuth 2.0 flow extensions"}, + {"title": "Storage", "filename": "a2a-auth-oauth-storage", "description": "OAuth 2.0 flow storage extensions"}, {"title": "Secrets", "filename": "a2a-auth-secrets", "description": "Secrets injection extensions"}, ], }, @@ -117,13 +118,6 @@ "title": "OAuth Extensions", "description": "OAuth 2.0 flow extensions", "import_path": "agentstack_sdk.a2a.extensions.auth.oauth", - "submodule_cards": [ - { - "title": "OAuth Storage", - "filename": "a2a-auth-oauth-storage", - "description": "Storage backends for OAuth flow state", - } - ], }, # ── a2a.auth.oauth.storage ──────────────────────────────────────────────── { @@ -182,14 +176,42 @@ "import_path": "agentstack_sdk.a2a.extensions.ui", }, # ── platform (grouped by sub-module) ────────────────────────────────────── + { + "json_key": None, + "filename": "platform-idx", + "title": "Platform API Overview", + "description": "Clients for files, vector stores, contexts, providers, and more", + "import_path": "agentstack_sdk.platform", + "submodule_cards": [ + {"title": "Platform", "filename": "platform", "description": "General platform client and utilities"}, + {"title": "Common", "filename": "platform-common", "description": "Shared types and utilities"}, + {"title": "Context", "filename": "platform-context", "description": "Context management"}, + ], + }, { "json_key": "agentstack_sdk.platform", "filename": "platform", - "title": "Platform API", + "title": "Platform", "description": "Clients for files, vector stores, contexts, providers, and more", "import_path": "agentstack_sdk.platform", "group_by_origin": True, }, + # ── platform.context ────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.platform.common", + "filename": "platform-common", + "title": "Common", + "description": "Shared types and utilities", + "import_path": "agentstack_sdk.platform.common", + }, + # ── platform.common ─────────────────────────────────────────────────────── + { + "json_key": "agentstack_sdk.platform.context", + "filename": "platform-context", + "title": "Context", + "description": "Context management", + "import_path": "agentstack_sdk.platform.context", + }, # ── types ───────────────────────────────────────────────────────────────── { "json_key": "agentstack_sdk.types", @@ -304,7 +326,7 @@ def _mdx_escape(text: str | None) -> str: _FILENAME_TO_PARENT: dict[str, str] = {} # child filename → parent filename -def _ensure_module_maps() -> None: +def _build_module_maps() -> None: if _JSON_KEY_TO_FILENAME: return for cfg in PAGE_CONFIG: @@ -319,7 +341,6 @@ def _ensure_module_maps() -> None: def _symbol_breadcrumb_ancestors(parent_filename: str) -> list[tuple[str, str]]: """Return ordered list of (title, filename) ancestors from root down to *parent_filename* (inclusive).""" - _ensure_module_maps() chain: list[tuple[str, str]] = [] current = parent_filename while current: @@ -332,7 +353,6 @@ def _symbol_breadcrumb_ancestors(parent_filename: str) -> list[tuple[str, str]]: def _find_longest_matching_json_key(origin: str) -> str | None: """Return the longest PAGE_CONFIG json_key that is a prefix of *origin*.""" - _ensure_module_maps() best_key: str | None = None best_len = 0 for key in _JSON_KEY_TO_FILENAME: @@ -364,7 +384,6 @@ def _symbol_page_parent_filename(item: dict) -> str: def _symbol_page_parent_title(parent_filename: str) -> str: """Human-readable title of the parent module page.""" - _ensure_module_maps() return _FILENAME_TO_TITLE.get(parent_filename, parent_filename.replace("-", " ").title()) @@ -532,10 +551,12 @@ def render_function_page( def main() -> None: + _build_module_maps() parser = argparse.ArgumentParser(description="Generate Python SDK reference docs (MDX) from exports_structure.json.") parser.add_argument( "--json-file", type=Path, + default=Path(__file__).resolve().parent / "exports_structure.json", help="Path to the exports_structure.json manifest", ) parser.add_argument( @@ -562,13 +583,12 @@ def main() -> None: data = json.loads(json_file.read_text()) env = _make_env(templates_dir) - _ensure_module_maps() - version = "development" - out_dir = docs_dir / version / "reference" / "python-sdk" + out_dir = docs_dir out_dir.mkdir(parents=True, exist_ok=True) # ── overview + module pages (as before) ────────────────────────────────── + version = "development" content = render_overview(env, version) (out_dir / "overview.mdx").write_text(content) diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py index 385bef49df..5a7b32ff67 100644 --- a/apps/agentstack-sdk-py/docs/introspect_exports.py +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -16,10 +16,6 @@ import griffe - - - - class ExportItem(BaseModel): model_config = ConfigDict(validate_assignment=True) name: str @@ -736,20 +732,16 @@ def main() -> None: api = trace_package(SRC_ROOT) # ── Phase 2: griffe enrichment ─────────────────────────────────────────── - print("\nLoading package with griffe for metadata enrichment...") - pkg = griffe.load("agentstack_sdk", search_paths=[str(SRC_ROOT.parent)]) enriched = enrich_api(api, pkg) - print(" ✓ griffe enrichment complete") out_file: Path = args.output out_file.parent.mkdir(parents=True, exist_ok=True) out_file.write_text(json.dumps(enriched, indent=2)) - print(f"\n→ Saved to {out_file}") pkg_count = len(enriched) name_count = sum(len(v) for v in enriched.values()) - print(f" {pkg_count} packages · {name_count} total exports") + print(f"Python SDK: Extracted {pkg_count} packages · {name_count} total exports") if __name__ == "__main__": diff --git a/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 index 70610e3c48..ab174b29ea 100644 --- a/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 +++ b/apps/agentstack-sdk-py/docs/templates/class.mdx.j2 @@ -9,7 +9,7 @@ description: "{{ cls.docstring | first_line }}" [Python SDK Reference]({{ base_href }}/overview){% for title, filename in breadcrumb_ancestors %} / [{{ title }}]({{ base_href }}/{{ filename }}){% endfor %} / {{ cls.name }} {%- endif %} -```python +```py from {{ import_path }} import {{ cls.name }} ``` {%- if cls.bases %} diff --git a/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 index 6c7303a915..36b9c5a739 100644 --- a/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 +++ b/apps/agentstack-sdk-py/docs/templates/function.mdx.j2 @@ -9,7 +9,7 @@ description: "{{ fn.docstring | first_line }}" [Python SDK Reference]({{ base_href }}/overview){% for title, filename in breadcrumb_ancestors %} / [{{ title }}]({{ base_href }}/{{ filename }}){% endfor %} / {{ fn.name }} {%- endif %} -```python +```py from {{ import_path }} import {{ fn.name }} ``` {%- if fn.labels %} @@ -24,11 +24,10 @@ Labels: {% for label in fn.labels %}`{{ label }}`{% if not loop.last %}, {% endi ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------| -{%- for p in fn.params %} -| `{{ p.name }}` | {% if p.type %}`{{ p.type | shorten_type }}`{% else %}—{% endif %} | {% if p.default %}`{{ p.default | truncate_val }}`{% else %}—{% endif %} | {{ p.docstring | first_line if p.docstring else '' }} | -{%- endfor %} +| Name | Type | Default | +|------|------|---------| +{% for p in fn.params %}| `{{ p.name }}` | {% if p.type %}`{{ p.type | table_type }}`{% else %}—{% endif %} | {% if p.default %}`{{ p.default | truncate_val }}`{% else %}—{% endif %} | +{% endfor %} {%- endif %} {%- if fn.returns %} diff --git a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 index 609cd08a2e..f6d7a90560 100644 --- a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 +++ b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 @@ -6,7 +6,7 @@ description: "{{ description }}" {{ autogen_warning }} {%- if import_example %} -```python +```py {{ import_example }} ``` {%- endif %} @@ -29,10 +29,6 @@ description: "{{ description }}" ## {{ group.title }} -```python -{{ group.import_example }} -``` - {%- endif %} {%- if group.classes %} {%- if not group.title %} diff --git a/apps/agentstack-sdk-py/tasks.toml b/apps/agentstack-sdk-py/tasks.toml index 3f118748c3..6ce88e0586 100644 --- a/apps/agentstack-sdk-py/tasks.toml +++ b/apps/agentstack-sdk-py/tasks.toml @@ -107,7 +107,7 @@ uv run python docs/introspect_exports.py \\ echo "Running generate_docs.py..." uv run python docs/generate_docs.py \\ --json-file "${TEMP_JSON}" \\ - --docs-dir "${DOCS_ROOT}" \\ + --docs-dir "${SDK_DOCS_DIR}" \\ --templates-dir "docs/templates" # Step 4: delete the introspect JSON diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx index 527092deda..f9de11f548 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx @@ -10,7 +10,7 @@ description: "Storage backends for OAuth flow state" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorage, MemoryTokenStorageFactory, TokenStorageFactory ``` --- diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx index 170f4e4cb2..e02629d32b 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorage -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorage +```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorage ``` **Bases:** `TokenStorage` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx index 683c79e8fb..d837b5a1fc 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorageFactory -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorageFactory +```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorageFactory ``` **Bases:** `TokenStorageFactory` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx index 80464a30d6..4647ef24f8 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / TokenStorageFactory -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / TokenStorageFactory +```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import TokenStorageFactory ``` **Bases:** `ABC` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth.mdx index 2c7a718fac..c7d9144a1e 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth.mdx @@ -10,14 +10,9 @@ description: "OAuth 2.0 flow extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import AuthRequest, AuthResponse, OAuthDemand # ... ``` - - - Storage backends for OAuth flow state - - --- ### Classes diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx index bb3c833aa0..34e449a6c8 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthRequest -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import AuthRequest ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx index bcdad6a253..4875c19446 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthResponse -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import AuthResponse ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx index edc351cff1..4ba54d763e 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthDemand -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthDemand ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx index f43f6994ae..f4541ad57b 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionClient ``` **Bases:** `BaseExtensionClient[OAuthExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx index 5e4acd2ed5..ac2fe7d8f6 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx index 6a01bf6213..4e110f46fc 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx index 574c9623ef..c7b66c7674 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionServer ``` **Bases:** `BaseExtensionServer[OAuthExtensionSpec, OAuthExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx index 54a5e46058..5040532eeb 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionSpec ``` **Bases:** `BaseExtensionSpec[OAuthExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx index c1e7399f01..704e796a20 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthFulfillment -```python +```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthFulfillment ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets.mdx index 0a116a64b5..5703965cec 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets.mdx @@ -10,7 +10,7 @@ description: "Secrets injection extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretDemand, SecretFulfillment, SecretsExtensionClient # ... ``` --- diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx index 9d1a49f1f4..9dea273ed4 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretDemand -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretDemand ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx index e1f18e3d39..2b636edc3a 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretFulfillment -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretFulfillment ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx index b87a58f147..113317f514 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionClient ``` **Bases:** `BaseExtensionClient[SecretsExtensionSpec, SecretsServiceExtensionParams]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx index 6d8d444fa3..90aa99174c 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionServer ``` **Bases:** `BaseExtensionServer[SecretsExtensionSpec, SecretsServiceExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx index 36d534d94a..d28c7fe085 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionSpec ``` **Bases:** `BaseExtensionSpec[SecretsServiceExtensionParams | None]` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx index 8416261739..aa57f521e4 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsServiceExtensionMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx index d792e1283c..e829ed2b97 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsServiceExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-auth.mdx b/docs/development/reference/python-sdk/a2a-auth.mdx index 45819937ce..5bd0bd773f 100644 --- a/docs/development/reference/python-sdk/a2a-auth.mdx +++ b/docs/development/reference/python-sdk/a2a-auth.mdx @@ -11,9 +11,12 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} - + OAuth 2.0 flow extensions + + OAuth 2.0 flow storage extensions + Secrets injection extensions diff --git a/docs/development/reference/python-sdk/a2a-common.mdx b/docs/development/reference/python-sdk/a2a-common.mdx index 918cf6b48d..2b149ace3e 100644 --- a/docs/development/reference/python-sdk/a2a-common.mdx +++ b/docs/development/reference/python-sdk/a2a-common.mdx @@ -10,7 +10,7 @@ description: "Shared base classes and form types for extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.common import BaseField, BaseFormRender, BaseFormResponse # ... ``` --- diff --git a/docs/development/reference/python-sdk/a2a-common/BaseField.mdx b/docs/development/reference/python-sdk/a2a-common/BaseField.mdx index 666ce72a77..79d3010cab 100644 --- a/docs/development/reference/python-sdk/a2a-common/BaseField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/BaseField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / BaseField -```python +```py from agentstack_sdk.a2a.extensions.common import BaseField ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx b/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx index 3433f2c158..2c8e2edd61 100644 --- a/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx +++ b/docs/development/reference/python-sdk/a2a-common/BaseFormRender.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / BaseFormRender -```python +```py from agentstack_sdk.a2a.extensions.common import BaseFormRender ``` **Bases:** `BaseModel , Generic[F]` diff --git a/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx b/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx index 79baf5cc14..959b4d0d44 100644 --- a/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-common/BaseFormResponse.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / BaseFormResponse -```python +```py from agentstack_sdk.a2a.extensions.common import BaseFormResponse ``` **Bases:** `BaseModel , Generic[FV]` diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx index b4111cb93c..1cecf53d4e 100644 --- a/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxField -```python +```py from agentstack_sdk.a2a.extensions.common import CheckboxField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx index 42abcf47bb..72a00118bd 100644 --- a/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import CheckboxFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx index 2fa4e56444..b4d68c0960 100644 --- a/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxGroupField -```python +```py from agentstack_sdk.a2a.extensions.common import CheckboxGroupField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx index 2fb2aad609..d1eb5639bb 100644 --- a/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/CheckboxGroupFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / CheckboxGroupFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import CheckboxGroupFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/DateField.mdx b/docs/development/reference/python-sdk/a2a-common/DateField.mdx index 7129af67de..6f3343dde8 100644 --- a/docs/development/reference/python-sdk/a2a-common/DateField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/DateField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / DateField -```python +```py from agentstack_sdk.a2a.extensions.common import DateField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx index 8ea8393fdc..8418dbefa9 100644 --- a/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/DateFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / DateFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import DateFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/FileField.mdx b/docs/development/reference/python-sdk/a2a-common/FileField.mdx index cc447a93c0..8b0d2919e3 100644 --- a/docs/development/reference/python-sdk/a2a-common/FileField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/FileField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileField -```python +```py from agentstack_sdk.a2a.extensions.common import FileField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx index 165b2449eb..99b119726f 100644 --- a/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/FileFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import FileFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx b/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx index ad50c3dcf4..8b987d8a72 100644 --- a/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx +++ b/docs/development/reference/python-sdk/a2a-common/FileInfo.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileInfo -```python +```py from agentstack_sdk.a2a.extensions.common import FileInfo ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/FileItem.mdx b/docs/development/reference/python-sdk/a2a-common/FileItem.mdx index 2766a613c5..ccfe5d1d3e 100644 --- a/docs/development/reference/python-sdk/a2a-common/FileItem.mdx +++ b/docs/development/reference/python-sdk/a2a-common/FileItem.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FileItem -```python +```py from agentstack_sdk.a2a.extensions.common import FileItem ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/FormRender.mdx b/docs/development/reference/python-sdk/a2a-common/FormRender.mdx index e86eaaec45..0cb487e3fd 100644 --- a/docs/development/reference/python-sdk/a2a-common/FormRender.mdx +++ b/docs/development/reference/python-sdk/a2a-common/FormRender.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FormRender -```python +```py from agentstack_sdk.a2a.extensions.common import FormRender ``` **Bases:** `BaseFormRender[FormField]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx b/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx index 8320a5a5c8..4376145e2d 100644 --- a/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-common/FormResponse.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / FormResponse -```python +```py from agentstack_sdk.a2a.extensions.common import FormResponse ``` **Bases:** `BaseFormResponse[FormFieldValue]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx b/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx index 8bf1cda2d6..52ab55f33b 100644 --- a/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/MultiSelectField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / MultiSelectField -```python +```py from agentstack_sdk.a2a.extensions.common import MultiSelectField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx index 1204ae3044..c8ec3c19db 100644 --- a/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/MultiSelectFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / MultiSelectFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import MultiSelectFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx b/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx index 8e43bf4265..a09fdebec6 100644 --- a/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx +++ b/docs/development/reference/python-sdk/a2a-common/OptionItem.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / OptionItem -```python +```py from agentstack_sdk.a2a.extensions.common import OptionItem ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx b/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx index daeebf676d..c51f335b5f 100644 --- a/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx +++ b/docs/development/reference/python-sdk/a2a-common/SettingsFormRender.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SettingsFormRender -```python +```py from agentstack_sdk.a2a.extensions.common import SettingsFormRender ``` **Bases:** `BaseFormRender[SettingsFormField]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx b/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx index 2d82178e6a..65fc6ba0ed 100644 --- a/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-common/SettingsFormResponse.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SettingsFormResponse -```python +```py from agentstack_sdk.a2a.extensions.common import SettingsFormResponse ``` **Bases:** `BaseFormResponse[SettingsFormFieldValue]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx b/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx index 98633fd023..f0ce6af22a 100644 --- a/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/SingleSelectField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SingleSelectField -```python +```py from agentstack_sdk.a2a.extensions.common import SingleSelectField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx index e5d01a2cfb..83c74a9b31 100644 --- a/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/SingleSelectFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / SingleSelectFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import SingleSelectFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-common/TextField.mdx b/docs/development/reference/python-sdk/a2a-common/TextField.mdx index 466d9335b9..63b3406a2b 100644 --- a/docs/development/reference/python-sdk/a2a-common/TextField.mdx +++ b/docs/development/reference/python-sdk/a2a-common/TextField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / TextField -```python +```py from agentstack_sdk.a2a.extensions.common import TextField ``` **Bases:** `BaseField` diff --git a/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx b/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx index ebe907f43a..e66ae4f090 100644 --- a/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-common/TextFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Common Types](/development/reference/python-sdk/a2a-common) / TextFieldValue -```python +```py from agentstack_sdk.a2a.extensions.common import TextFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx index 6124ce4c12..6d6f6b2d31 100644 --- a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / BaseExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.base import BaseExtensionClient ``` **Bases:** `ABC , typing.Generic[ExtensionSpecT, MetadataFromServerT]` diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx index 05acad1c30..1915c2541f 100644 --- a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / BaseExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.base import BaseExtensionServer ``` **Bases:** `ABC , typing.Generic[ExtensionSpecT, MetadataFromClientT]` diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx index 23c34842b7..15595417fd 100644 --- a/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-extensions-base/BaseExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / BaseExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.base import BaseExtensionSpec ``` **Bases:** `ABC , typing.Generic[ParamsT]` diff --git a/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx index 60ec41539d..0aaef6366d 100644 --- a/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-extensions-base/NoParamsBaseExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Base](/development/reference/python-sdk/a2a-extensions-base) / NoParamsBaseExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.base import NoParamsBaseExtensionSpec ``` **Bases:** `BaseExtensionSpec[NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx b/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx index 7f1203dabd..fd473c67b9 100644 --- a/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx +++ b/docs/development/reference/python-sdk/a2a-extensions-exceptions/ExtensionError.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions Exceptions](/development/reference/python-sdk/a2a-extensions-exceptions) / ExtensionError -```python +```py from agentstack_sdk.a2a.extensions.exceptions import ExtensionError ``` **Bases:** `Exception` diff --git a/docs/development/reference/python-sdk/a2a-interactions.mdx b/docs/development/reference/python-sdk/a2a-interactions.mdx index f967959d77..ebdf24b910 100644 --- a/docs/development/reference/python-sdk/a2a-interactions.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions.mdx @@ -10,7 +10,7 @@ description: "Human-in-the-loop interaction extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionClient, ApprovalExtensionMetadata, ApprovalExtensionParams # ... ``` --- diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx index f05dd86e1b..584b6c0b87 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionClient ``` **Bases:** `BaseExtensionClient[ApprovalExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx index 8e9ecbf45e..b73e7a49cb 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionMetadata ``` **Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx index 5a6895d554..689d7dfdba 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionParams ``` **Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx index a27cee2862..3b58a02743 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionServer ``` **Bases:** `BaseExtensionServer[ApprovalExtensionSpec, ApprovalExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx index 9c5742a7f9..286693d0a9 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionSpec ``` **Bases:** `BaseExtensionSpec[ApprovalExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx index 4552ebf3e5..8aa503a627 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalRejectionError.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalRejectionError -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalRejectionError ``` **Bases:** `RuntimeError` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx b/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx index 1cb0e3a399..6b63a863e1 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ApprovalResponse.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ApprovalResponse -```python +```py from agentstack_sdk.a2a.extensions.interactions import ApprovalResponse ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx b/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx index f989629f46..6fdaae6651 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/GenericApprovalRequest.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / GenericApprovalRequest -```python +```py from agentstack_sdk.a2a.extensions.interactions import GenericApprovalRequest ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx b/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx index 4bed7712de..6b177cabec 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ToolCallApprovalRequest -```python +```py from agentstack_sdk.a2a.extensions.interactions import ToolCallApprovalRequest ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx b/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx index ceca2c6416..c1fd95218c 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ToolCallServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Interaction Extensions](/development/reference/python-sdk/a2a-interactions) / ToolCallServer -```python +```py from agentstack_sdk.a2a.extensions.interactions import ToolCallServer ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services.mdx b/docs/development/reference/python-sdk/a2a-services.mdx index f471422b2e..da5bf3db72 100644 --- a/docs/development/reference/python-sdk/a2a-services.mdx +++ b/docs/development/reference/python-sdk/a2a-services.mdx @@ -10,7 +10,7 @@ description: "LLM, embedding, MCP, and platform service extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingDemand, EmbeddingFulfillment, EmbeddingServiceExtensionClient # ... ``` --- diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx index a40728d027..db989aea55 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingDemand.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingDemand -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingDemand ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx index f66bdb5391..30a3bae37a 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingFulfillment.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingFulfillment -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingFulfillment ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx index 89abf799c0..d78a4b8b0c 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionClient ``` **Bases:** `BaseExtensionClient[EmbeddingServiceExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx index 99d2fa495a..9d76b823a9 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx index 1cb7c66408..7e80a00749 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx index 9c05b52f8f..938db1cedf 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionServer ``` **Bases:** `BaseExtensionServer[EmbeddingServiceExtensionSpec, EmbeddingServiceExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx index a1ce423d5c..3c2a397980 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / EmbeddingServiceExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionSpec ``` **Bases:** `BaseExtensionSpec[EmbeddingServiceExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx b/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx index 310d57a7fe..5153415215 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormDemands.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormDemands -```python +```py from agentstack_sdk.a2a.extensions.services import FormDemands ``` **Bases:** `TypedDict` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx index b2345096f4..9c1d023cbb 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.services import FormServiceExtensionClient ``` **Bases:** `BaseExtensionClient[FormServiceExtensionSpec, FormRender]` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx index 0dad181ec7..fd5ec59199 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.services import FormServiceExtensionMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx index dc83746a1e..b0d11eb4f6 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.services import FormServiceExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx index d1bc3563b4..fa0ff57c48 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.services import FormServiceExtensionServer ``` **Bases:** `BaseExtensionServer[FormServiceExtensionSpec, FormServiceExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx index 60b32e5d8f..9b48ec5e76 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / FormServiceExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.services import FormServiceExtensionSpec ``` **Bases:** `BaseExtensionSpec[FormServiceExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx b/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx index 0e1b2940be..514d9b630c 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMDemand.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMDemand -```python +```py from agentstack_sdk.a2a.extensions.services import LLMDemand ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx b/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx index a6c28fe8f7..4950769ad6 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMFulfillment.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMFulfillment -```python +```py from agentstack_sdk.a2a.extensions.services import LLMFulfillment ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx index 577d7d8dc1..0bdebab2b4 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionClient ``` **Bases:** `BaseExtensionClient[LLMServiceExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx index 853366fa22..da4bf67747 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx index 062b4f9084..153ecb49cf 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx index 9bc36b7950..035abdec2f 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionServer ``` **Bases:** `BaseExtensionServer[LLMServiceExtensionSpec, LLMServiceExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx index 8ae34fc323..faa521d449 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / LLMServiceExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionSpec ``` **Bases:** `BaseExtensionSpec[LLMServiceExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx b/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx index c058bdf251..eb7155e9e4 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPDemand.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPDemand -```python +```py from agentstack_sdk.a2a.extensions.services import MCPDemand ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx b/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx index 0292a4f88b..0cb4e0d819 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPFulfillment.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPFulfillment -```python +```py from agentstack_sdk.a2a.extensions.services import MCPFulfillment ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx index c368950879..1eb82b3d23 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionClient ``` **Bases:** `BaseExtensionClient[MCPServiceExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx index 0173790653..de64755694 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx index b9b6b5850a..f713e78342 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx index a6a536ec6a..d20249184f 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionServer ``` **Bases:** `BaseExtensionServer[MCPServiceExtensionSpec, MCPServiceExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx index 537488c8ec..24b0254d0f 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / MCPServiceExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionSpec ``` **Bases:** `BaseExtensionSpec[MCPServiceExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx index 97d879bcc0..0493cfe339 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtension.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtension -```python +```py from agentstack_sdk.a2a.extensions.services import PlatformApiExtension ``` **Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx index dd164cab9f..2118da46d0 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionClient ``` **Bases:** `BaseExtensionClient[PlatformApiExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx index 755cd225d4..64e4b5c31a 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionMetadata ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx index 450221b0dc..6b3bbc0938 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx index 7cf372f6f3..53100a48f9 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionServer ``` **Bases:** `BaseExtensionServer[PlatformApiExtensionSpec, PlatformApiExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx index f4d6698f5c..0292604e17 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / PlatformApiExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionSpec ``` **Bases:** `BaseExtensionSpec[PlatformApiExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx b/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx index b17e8683f1..f4de040788 100644 --- a/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx +++ b/docs/development/reference/python-sdk/a2a-services/StdioTransport.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / StdioTransport -```python +```py from agentstack_sdk.a2a.extensions.services import StdioTransport ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx b/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx index bb83a42782..83f7db68ec 100644 --- a/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx +++ b/docs/development/reference/python-sdk/a2a-services/StreamableHTTPTransport.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Service Extensions](/development/reference/python-sdk/a2a-services) / StreamableHTTPTransport -```python +```py from agentstack_sdk.a2a.extensions.services import StreamableHTTPTransport ``` **Bases:** `SecureBaseModel` diff --git a/docs/development/reference/python-sdk/a2a-tools.mdx b/docs/development/reference/python-sdk/a2a-tools.mdx index 084b9208ee..a028216f62 100644 --- a/docs/development/reference/python-sdk/a2a-tools.mdx +++ b/docs/development/reference/python-sdk/a2a-tools.mdx @@ -10,7 +10,7 @@ description: "Tool call approval extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionClient, ToolCallExtensionMetadata, ToolCallExtensionParams # ... ``` --- diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx index 25cb41dfea..899116879e 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionClient ``` **Bases:** `BaseExtensionClient[ToolCallExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx index 4fc864b5a1..72734e1d71 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionMetadata -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionMetadata ``` **Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx index fd23d476e4..a08043b005 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionParams ``` **Bases:** `BaseModel` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx index 7542f6ed03..bf08fa8106 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionServer ``` **Bases:** `BaseExtensionServer[ToolCallExtensionSpec, ToolCallExtensionMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx index d41c65eb01..a74df46be0 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionSpec ``` **Bases:** `BaseExtensionSpec[ToolCallExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx index 03abdaeda4..07f91d6ec1 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallRejectionError.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallRejectionError -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallRejectionError ``` **Bases:** `RuntimeError` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx index 435ddef4d1..c50092d0d7 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallRequest -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallRequest ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx index 4019e74db2..19944e458a 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallResponse.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallResponse -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallResponse ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx index f12e743431..87c7841103 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Tool Extensions](/development/reference/python-sdk/a2a-tools) / ToolCallServer -```python +```py from agentstack_sdk.a2a.extensions.tools import ToolCallServer ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx b/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx index b143aa7801..39ebc0b56b 100644 --- a/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx +++ b/docs/development/reference/python-sdk/a2a-types/AgentArtifact.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / AgentArtifact -```python +```py from agentstack_sdk.a2a.types import AgentArtifact ``` **Bases:** `Artifact` diff --git a/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx b/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx index b214702530..3b7a53439c 100644 --- a/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx +++ b/docs/development/reference/python-sdk/a2a-types/AgentMessage.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / AgentMessage -```python +```py from agentstack_sdk.a2a.types import AgentMessage ``` **Bases:** `Message` diff --git a/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx b/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx index 21831a37cc..dc6d3ce191 100644 --- a/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx +++ b/docs/development/reference/python-sdk/a2a-types/ArtifactChunk.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / ArtifactChunk -```python +```py from agentstack_sdk.a2a.types import ArtifactChunk ``` **Bases:** `Artifact` diff --git a/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx b/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx index acf590cebc..2a5b7e0019 100644 --- a/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx +++ b/docs/development/reference/python-sdk/a2a-types/AuthRequired.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / AuthRequired -```python +```py from agentstack_sdk.a2a.types import AuthRequired ``` **Bases:** `InputRequired` diff --git a/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx b/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx index f188523fab..b0a4aca76c 100644 --- a/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx +++ b/docs/development/reference/python-sdk/a2a-types/InputRequired.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / InputRequired -```python +```py from agentstack_sdk.a2a.types import InputRequired ``` **Bases:** `TaskStatus` diff --git a/docs/development/reference/python-sdk/a2a-types/Metadata.mdx b/docs/development/reference/python-sdk/a2a-types/Metadata.mdx index da05e12908..93c5dacdf9 100644 --- a/docs/development/reference/python-sdk/a2a-types/Metadata.mdx +++ b/docs/development/reference/python-sdk/a2a-types/Metadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Types](/development/reference/python-sdk/a2a-types) / Metadata -```python +```py from agentstack_sdk.a2a.types import Metadata ``` **Bases:** `dict[str, JsonValue]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui.mdx b/docs/development/reference/python-sdk/a2a-ui.mdx index 1f27eb6bea..48f88048cb 100644 --- a/docs/development/reference/python-sdk/a2a-ui.mdx +++ b/docs/development/reference/python-sdk/a2a-ui.mdx @@ -10,7 +10,7 @@ description: "Rich UI component extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetail, AgentDetailContributor, AgentDetailExtensionClient # ... ``` --- diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx index f16112ad2b..11d12482b7 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetail.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetail -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetail ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx index b106f43083..8af6795f85 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailContributor.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailContributor -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetailContributor ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx index 1a9473500b..078040e78f 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetailExtensionClient ``` **Bases:** `BaseExtensionClient[AgentDetailExtensionSpec, AgentDetail]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx index b52da18a6a..00c6e382cc 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetailExtensionServer ``` **Bases:** `BaseExtensionServer[AgentDetailExtensionSpec, NoneType]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx index ae266f864c..f215f38564 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetailExtensionSpec ``` **Bases:** `BaseExtensionSpec[AgentDetail]` diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx index 941e9e6a15..8893984939 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentDetailTool.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentDetailTool -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentDetailTool ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx b/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx index 4bda5f50c0..6a2f924dfb 100644 --- a/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/AgentRunSettings.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / AgentRunSettings -```python +```py from agentstack_sdk.a2a.extensions.ui import AgentRunSettings ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx index 2e014888dc..c3f2c8c67f 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequest.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasEditRequest -```python +```py from agentstack_sdk.a2a.extensions.ui import CanvasEditRequest ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx index d565073d67..9c330e0585 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasEditRequestMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasEditRequestMetadata -```python +```py from agentstack_sdk.a2a.extensions.ui import CanvasEditRequestMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx index 37d162eefd..20b534a8e5 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import CanvasExtensionServer ``` **Bases:** `BaseExtensionServer[CanvasExtensionSpec, CanvasEditRequestMetadata]` diff --git a/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx index b360ae8ce1..0ac3f8a21b 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CanvasExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CanvasExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import CanvasExtensionSpec ``` **Bases:** `NoParamsBaseExtensionSpec` diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx index 420ed40961..565603bf2a 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxField -```python +```py from agentstack_sdk.a2a.extensions.ui import CheckboxField ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx index bb64b4514c..2b27bd2e5f 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxFieldValue -```python +```py from agentstack_sdk.a2a.extensions.ui import CheckboxFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx index 4f4c20d4cf..d0c22536b1 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxGroupField -```python +```py from agentstack_sdk.a2a.extensions.ui import CheckboxGroupField ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx index 3da9444a60..510c378951 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CheckboxGroupFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CheckboxGroupFieldValue -```python +```py from agentstack_sdk.a2a.extensions.ui import CheckboxGroupFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/Citation.mdx b/docs/development/reference/python-sdk/a2a-ui/Citation.mdx index b66dd295ed..2b6a019f5a 100644 --- a/docs/development/reference/python-sdk/a2a-ui/Citation.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/Citation.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / Citation -```python +```py from agentstack_sdk.a2a.extensions.ui import Citation ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx index d6ef3845ad..ec737a1bff 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.ui import CitationExtensionClient ``` **Bases:** `BaseExtensionClient[CitationExtensionSpec, CitationMetadata]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx index 325b9ef448..dfffabe7e1 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import CitationExtensionServer ``` **Bases:** `BaseExtensionServer[CitationExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx index cd7af7ca92..c848a78a7c 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import CitationExtensionSpec ``` **Bases:** `NoParamsBaseExtensionSpec` diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx index f5e234bae3..ed9ca50db6 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CitationMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / CitationMetadata -```python +```py from agentstack_sdk.a2a.extensions.ui import CitationMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx b/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx index 4d960e1574..401d12c523 100644 --- a/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/EnvVar.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / EnvVar -```python +```py from agentstack_sdk.a2a.extensions.ui import EnvVar ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/Error.mdx b/docs/development/reference/python-sdk/a2a-ui/Error.mdx index 79b0bd86d6..6dc3a9b290 100644 --- a/docs/development/reference/python-sdk/a2a-ui/Error.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/Error.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / Error -```python +```py from agentstack_sdk.a2a.extensions.ui import Error ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx index d850d8ad62..192fd4e705 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorContext.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorContext -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorContext ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx index 96c57f8212..7e287e29c1 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorExtensionClient ``` **Bases:** `BaseExtensionClient[ErrorExtensionSpec, ErrorMetadata]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx index 907c3fe7bf..99d557301b 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionParams.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionParams -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorExtensionParams ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx index 8ac9762940..f0bfea9b9e 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorExtensionServer ``` **Bases:** `BaseExtensionServer[ErrorExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx index 74cce9dcf5..3b91ddf032 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorExtensionSpec ``` **Bases:** `BaseExtensionSpec[ErrorExtensionParams]` diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx index 4b40d9b08d..8ed225ef61 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorGroup.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorGroup -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorGroup ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx b/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx index 84bc2fef37..1fbe8ebe04 100644 --- a/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/ErrorMetadata.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / ErrorMetadata -```python +```py from agentstack_sdk.a2a.extensions.ui import ErrorMetadata ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx index 4884b6f89e..39cfc2fd64 100644 --- a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / FormRequestExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionClient ``` **Bases:** `BaseExtensionClient[FormRequestExtensionSpec, FormRender]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx index 6531ce1120..8469a77b83 100644 --- a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / FormRequestExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionServer ``` **Bases:** `BaseExtensionServer[FormRequestExtensionSpec, FormResponse]` diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx index 26de18cc88..109463d3eb 100644 --- a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / FormRequestExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionSpec ``` **Bases:** `NoParamsBaseExtensionSpec` diff --git a/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx b/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx index 7ee6d4b588..e6df860ee2 100644 --- a/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/OptionItem.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / OptionItem -```python +```py from agentstack_sdk.a2a.extensions.ui import OptionItem ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx index 783c986e87..09aea922a3 100644 --- a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.ui import SettingsExtensionClient ``` **Bases:** `BaseExtensionClient[SettingsExtensionSpec, SettingsRender]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx index ba4925af7a..a6ff25c896 100644 --- a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import SettingsExtensionServer ``` **Bases:** `BaseExtensionServer[SettingsExtensionSpec, AgentRunSettings]` diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx index a2d9f8ce48..bb9198d4d3 100644 --- a/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import SettingsExtensionSpec ``` **Bases:** `BaseExtensionSpec[SettingsRender | None]` diff --git a/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx b/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx index 94daf6e5a5..8e2c0b1dff 100644 --- a/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/SettingsRender.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SettingsRender -```python +```py from agentstack_sdk.a2a.extensions.ui import SettingsRender ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx b/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx index b9889a3c0f..a166d6e241 100644 --- a/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/SingleSelectField.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SingleSelectField -```python +```py from agentstack_sdk.a2a.extensions.ui import SingleSelectField ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx b/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx index 4ecdb8d4a1..15f3a16c05 100644 --- a/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/SingleSelectFieldValue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / SingleSelectFieldValue -```python +```py from agentstack_sdk.a2a.extensions.ui import SingleSelectFieldValue ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx b/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx index 0684ee9f89..287ed9823f 100644 --- a/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/Trajectory.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / Trajectory -```python +```py from agentstack_sdk.a2a.extensions.ui import Trajectory ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx index 80da6c54c7..2172bc53c2 100644 --- a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionClient.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / TrajectoryExtensionClient -```python +```py from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionClient ``` **Bases:** `BaseExtensionClient[TrajectoryExtensionSpec, Trajectory]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx index 60763e4365..557ab34bdb 100644 --- a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / TrajectoryExtensionServer -```python +```py from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionServer ``` **Bases:** `BaseExtensionServer[TrajectoryExtensionSpec, NoneType]` diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx index 60489dae9f..3e90f2291a 100644 --- a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionSpec.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [UI Extensions](/development/reference/python-sdk/a2a-ui) / TrajectoryExtensionSpec -```python +```py from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionSpec ``` **Bases:** `NoParamsBaseExtensionSpec` diff --git a/docs/development/reference/python-sdk/platform-common.mdx b/docs/development/reference/python-sdk/platform-common.mdx new file mode 100644 index 0000000000..70179fd1e0 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-common.mdx @@ -0,0 +1,28 @@ +--- +title: "Common" +description: "Shared types and utilities" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```py +from agentstack_sdk.platform.common import GithubVersionType, PaginatedResult, ResolvedDockerImageID # ... +``` +--- +### Classes + + + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/GithubVersionType.mdx b/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx similarity index 65% rename from docs/development/reference/python-sdk/platform/GithubVersionType.mdx rename to docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx index d5ad870700..6f84d393fc 100644 --- a/docs/development/reference/python-sdk/platform/GithubVersionType.mdx +++ b/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / GithubVersionType -```python -from agentstack_sdk.platform import GithubVersionType +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / GithubVersionType +```py +from agentstack_sdk.platform.common import GithubVersionType ``` **Bases:** `StrEnum` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/PaginatedResult.mdx b/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx similarity index 70% rename from docs/development/reference/python-sdk/platform/PaginatedResult.mdx rename to docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx index f3098a838d..8fee0395a5 100644 --- a/docs/development/reference/python-sdk/platform/PaginatedResult.mdx +++ b/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / PaginatedResult -```python -from agentstack_sdk.platform import PaginatedResult +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / PaginatedResult +```py +from agentstack_sdk.platform.common import PaginatedResult ``` **Bases:** `BaseModel , Generic[T]` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx b/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx similarity index 67% rename from docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx rename to docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx index f5ef8d1c72..d982111169 100644 --- a/docs/development/reference/python-sdk/platform/ResolvedDockerImageID.mdx +++ b/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ResolvedDockerImageID -```python -from agentstack_sdk.platform import ResolvedDockerImageID +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / ResolvedDockerImageID +```py +from agentstack_sdk.platform.common import ResolvedDockerImageID ``` **Bases:** `BaseModel` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx b/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx similarity index 72% rename from docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx rename to docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx index b8160f6a55..472990b03c 100644 --- a/docs/development/reference/python-sdk/platform/ResolvedGithubUrl.mdx +++ b/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ResolvedGithubUrl -```python -from agentstack_sdk.platform import ResolvedGithubUrl +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / ResolvedGithubUrl +```py +from agentstack_sdk.platform.common import ResolvedGithubUrl ``` **Bases:** `BaseModel` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform-context.mdx b/docs/development/reference/python-sdk/platform-context.mdx new file mode 100644 index 0000000000..856aa65f42 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-context.mdx @@ -0,0 +1,30 @@ +--- +title: "Context" +description: "Context management" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +```py +from agentstack_sdk.platform.context import Context, ContextHistoryItem, ContextPermissions # ... +``` +--- +### Classes + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/Context.mdx b/docs/development/reference/python-sdk/platform-context/Context.mdx similarity index 95% rename from docs/development/reference/python-sdk/platform/Context.mdx rename to docs/development/reference/python-sdk/platform-context/Context.mdx index cd5d565c14..793cc553f5 100644 --- a/docs/development/reference/python-sdk/platform/Context.mdx +++ b/docs/development/reference/python-sdk/platform-context/Context.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Context -```python -from agentstack_sdk.platform import Context +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / Context +```py +from agentstack_sdk.platform.context import Context ``` **Bases:** `BaseModel` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx b/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx similarity index 72% rename from docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx rename to docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx index 3105d00547..51256f1437 100644 --- a/docs/development/reference/python-sdk/platform/ContextHistoryItem.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ContextHistoryItem -```python -from agentstack_sdk.platform import ContextHistoryItem +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / ContextHistoryItem +```py +from agentstack_sdk.platform.context import ContextHistoryItem ``` **Bases:** `BaseModel` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/ContextPermissions.mdx b/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx similarity index 71% rename from docs/development/reference/python-sdk/platform/ContextPermissions.mdx rename to docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx index f2a1cbbc59..26c1b961ed 100644 --- a/docs/development/reference/python-sdk/platform/ContextPermissions.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ContextPermissions -```python -from agentstack_sdk.platform import ContextPermissions +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / ContextPermissions +```py +from agentstack_sdk.platform.context import ContextPermissions ``` **Bases:** `BaseModel` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/ContextToken.mdx b/docs/development/reference/python-sdk/platform-context/ContextToken.mdx similarity index 68% rename from docs/development/reference/python-sdk/platform/ContextToken.mdx rename to docs/development/reference/python-sdk/platform-context/ContextToken.mdx index 95f444e4e8..1ea82ca0c5 100644 --- a/docs/development/reference/python-sdk/platform/ContextToken.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextToken.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ContextToken -```python -from agentstack_sdk.platform import ContextToken +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / ContextToken +```py +from agentstack_sdk.platform.context import ContextToken ``` **Bases:** `BaseModel` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform/Permissions.mdx b/docs/development/reference/python-sdk/platform-context/Permissions.mdx similarity index 81% rename from docs/development/reference/python-sdk/platform/Permissions.mdx rename to docs/development/reference/python-sdk/platform-context/Permissions.mdx index ee19711a05..b4e2ac4522 100644 --- a/docs/development/reference/python-sdk/platform/Permissions.mdx +++ b/docs/development/reference/python-sdk/platform-context/Permissions.mdx @@ -10,9 +10,9 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Permissions -```python -from agentstack_sdk.platform import Permissions +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / Permissions +```py +from agentstack_sdk.platform.context import Permissions ``` **Bases:** `ContextPermissions` ## Class Attributes diff --git a/docs/development/reference/python-sdk/platform-idx.mdx b/docs/development/reference/python-sdk/platform-idx.mdx new file mode 100644 index 0000000000..20525aebae --- /dev/null +++ b/docs/development/reference/python-sdk/platform-idx.mdx @@ -0,0 +1,23 @@ +--- +title: "Platform API Overview" +description: "Clients for files, vector stores, contexts, providers, and more" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} + + + General platform client and utilities + + + Shared types and utilities + + + Context management + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform.mdx b/docs/development/reference/python-sdk/platform.mdx index 9ede899cdb..472f829bc5 100644 --- a/docs/development/reference/python-sdk/platform.mdx +++ b/docs/development/reference/python-sdk/platform.mdx @@ -1,5 +1,5 @@ --- -title: "Platform API" +title: "Platform" description: "Clients for files, vector stores, contexts, providers, and more" --- @@ -10,16 +10,12 @@ description: "Clients for files, vector stores, contexts, providers, and more" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.platform import PlatformClient, SystemConfiguration, AuthorizationCodeRequest # ... ``` --- ## Client - -```python -from agentstack_sdk.platform.client import PlatformClient, get_platform_client, set_platform_client # ... -``` ### Classes @@ -39,10 +35,6 @@ from agentstack_sdk.platform.client import PlatformClient, get_platform_client, --- ## Configuration - -```python -from agentstack_sdk.platform.configuration import SystemConfiguration -``` ### Classes @@ -52,10 +44,6 @@ from agentstack_sdk.platform.configuration import SystemConfiguration --- ## Connector - -```python -from agentstack_sdk.platform.connector import AuthorizationCodeRequest, Connector, ConnectorPreset # ... -``` ### Classes @@ -85,10 +73,6 @@ from agentstack_sdk.platform.connector import AuthorizationCodeRequest, Connecto --- ## File - -```python -from agentstack_sdk.platform.file import ExtractedFileInfo, Extraction, File -``` ### Classes @@ -108,10 +92,6 @@ from agentstack_sdk.platform.file import ExtractedFileInfo, Extraction, File --- ## Model Provider - -```python -from agentstack_sdk.platform.model_provider import ModelCapability, ModelProvider, ModelProviderState # ... -``` ### Classes @@ -129,10 +109,6 @@ from agentstack_sdk.platform.model_provider import ModelCapability, ModelProvide --- ## Provider - -```python -from agentstack_sdk.platform.provider import EnvVar, Provider, ProviderErrorMessage # ... -``` ### Classes @@ -148,10 +124,6 @@ from agentstack_sdk.platform.provider import EnvVar, Provider, ProviderErrorMess --- ## Provider Build - -```python -from agentstack_sdk.platform.provider_build import AddProvider, BuildConfiguration, BuildState # ... -``` ### Classes @@ -177,10 +149,6 @@ from agentstack_sdk.platform.provider_build import AddProvider, BuildConfigurati --- ## Provider Discovery - -```python -from agentstack_sdk.platform.provider_discovery import DiscoveryState, ProviderDiscovery -``` ### Classes @@ -192,10 +160,6 @@ from agentstack_sdk.platform.provider_discovery import DiscoveryState, ProviderD --- ## User - -```python -from agentstack_sdk.platform.user import ChangeRoleResponse, User, UserRole -``` ### Classes @@ -209,10 +173,6 @@ from agentstack_sdk.platform.user import ChangeRoleResponse, User, UserRole --- ## User Feedback - -```python -from agentstack_sdk.platform.user_feedback import ListUserFeedbackResponse, UserFeedback -``` ### Classes @@ -224,10 +184,6 @@ from agentstack_sdk.platform.user_feedback import ListUserFeedbackResponse, User --- ## Vector Store - -```python -from agentstack_sdk.platform.vector_store import VectorStore, VectorStoreDocument, VectorStoreItem # ... -``` ### Classes diff --git a/docs/development/reference/python-sdk/platform/AddProvider.mdx b/docs/development/reference/python-sdk/platform/AddProvider.mdx index abe953a584..36b17ed80a 100644 --- a/docs/development/reference/python-sdk/platform/AddProvider.mdx +++ b/docs/development/reference/python-sdk/platform/AddProvider.mdx @@ -10,8 +10,8 @@ description: "Will add a new provider or update an existing one with the same ba DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / AddProvider -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / AddProvider +```py from agentstack_sdk.platform import AddProvider ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx b/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx index 654c3a303f..5583cfbadf 100644 --- a/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx +++ b/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx @@ -10,8 +10,8 @@ description: "Authorization request for code-based OAuth flow" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / AuthorizationCodeRequest -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / AuthorizationCodeRequest +```py from agentstack_sdk.platform import AuthorizationCodeRequest ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx index f0078a08af..46f33733e5 100644 --- a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx +++ b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / BuildConfiguration -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / BuildConfiguration +```py from agentstack_sdk.platform import BuildConfiguration ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/BuildState.mdx b/docs/development/reference/python-sdk/platform/BuildState.mdx index 1655e484a3..4859aa5b38 100644 --- a/docs/development/reference/python-sdk/platform/BuildState.mdx +++ b/docs/development/reference/python-sdk/platform/BuildState.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / BuildState -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / BuildState +```py from agentstack_sdk.platform import BuildState ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx b/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx index 86340ab644..7a90ea8ebe 100644 --- a/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx +++ b/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ChangeRoleResponse -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ChangeRoleResponse +```py from agentstack_sdk.platform import ChangeRoleResponse ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/Connector.mdx b/docs/development/reference/python-sdk/platform/Connector.mdx index ef1ac25f93..c08d102473 100644 --- a/docs/development/reference/python-sdk/platform/Connector.mdx +++ b/docs/development/reference/python-sdk/platform/Connector.mdx @@ -10,8 +10,8 @@ description: "Represents a configured connector instance" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Connector -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Connector +```py from agentstack_sdk.platform import Connector ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx b/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx index bb0aefc8dc..e59eadcc01 100644 --- a/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx +++ b/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx @@ -10,8 +10,8 @@ description: "Represents a preset connector configuration" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ConnectorPreset -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ConnectorPreset +```py from agentstack_sdk.platform import ConnectorPreset ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ConnectorState.mdx b/docs/development/reference/python-sdk/platform/ConnectorState.mdx index d3cd1d11b7..9f975dd2af 100644 --- a/docs/development/reference/python-sdk/platform/ConnectorState.mdx +++ b/docs/development/reference/python-sdk/platform/ConnectorState.mdx @@ -10,8 +10,8 @@ description: "Enumeration of possible connector states" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ConnectorState -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ConnectorState +```py from agentstack_sdk.platform import ConnectorState ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/DiscoveryState.mdx b/docs/development/reference/python-sdk/platform/DiscoveryState.mdx index 185d1191ac..88e26ade13 100644 --- a/docs/development/reference/python-sdk/platform/DiscoveryState.mdx +++ b/docs/development/reference/python-sdk/platform/DiscoveryState.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / DiscoveryState -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / DiscoveryState +```py from agentstack_sdk.platform import DiscoveryState ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/EnvVar.mdx b/docs/development/reference/python-sdk/platform/EnvVar.mdx index 11aba0369f..22e6c575d2 100644 --- a/docs/development/reference/python-sdk/platform/EnvVar.mdx +++ b/docs/development/reference/python-sdk/platform/EnvVar.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / EnvVar -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / EnvVar +```py from agentstack_sdk.platform import EnvVar ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx b/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx index b2a7defd8e..daf37cfe91 100644 --- a/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx +++ b/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx @@ -10,8 +10,8 @@ description: "Information about an extracted file" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ExtractedFileInfo -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ExtractedFileInfo +```py from agentstack_sdk.platform import ExtractedFileInfo ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/Extraction.mdx b/docs/development/reference/python-sdk/platform/Extraction.mdx index 44bf8fa704..e8e9fa39c7 100644 --- a/docs/development/reference/python-sdk/platform/Extraction.mdx +++ b/docs/development/reference/python-sdk/platform/Extraction.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Extraction -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Extraction +```py from agentstack_sdk.platform import Extraction ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/File.mdx b/docs/development/reference/python-sdk/platform/File.mdx index 7df737bff0..44789215a2 100644 --- a/docs/development/reference/python-sdk/platform/File.mdx +++ b/docs/development/reference/python-sdk/platform/File.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / File -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / File +```py from agentstack_sdk.platform import File ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx b/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx index a5cf88b6ab..29b8d7b9cc 100644 --- a/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx +++ b/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ListUserFeedbackResponse -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ListUserFeedbackResponse +```py from agentstack_sdk.platform import ListUserFeedbackResponse ``` **Bases:** `PaginatedResult[UserFeedback]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx b/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx index 33e74d1a73..0048fd0847 100644 --- a/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx +++ b/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx @@ -10,8 +10,8 @@ description: "Response from an MCP proxy request with headers and streaming cont DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / MCPProxyResponse -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / MCPProxyResponse +```py from agentstack_sdk.platform import MCPProxyResponse ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ModelCapability.mdx b/docs/development/reference/python-sdk/platform/ModelCapability.mdx index 47ecbb5b77..6cd7e3580e 100644 --- a/docs/development/reference/python-sdk/platform/ModelCapability.mdx +++ b/docs/development/reference/python-sdk/platform/ModelCapability.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelCapability -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelCapability +```py from agentstack_sdk.platform import ModelCapability ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/ModelProvider.mdx b/docs/development/reference/python-sdk/platform/ModelProvider.mdx index ba60ba6b75..e21f6ee4b7 100644 --- a/docs/development/reference/python-sdk/platform/ModelProvider.mdx +++ b/docs/development/reference/python-sdk/platform/ModelProvider.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelProvider -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelProvider +```py from agentstack_sdk.platform import ModelProvider ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ModelProviderState.mdx b/docs/development/reference/python-sdk/platform/ModelProviderState.mdx index 4381b5c850..44a52cc8e8 100644 --- a/docs/development/reference/python-sdk/platform/ModelProviderState.mdx +++ b/docs/development/reference/python-sdk/platform/ModelProviderState.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelProviderState -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelProviderState +```py from agentstack_sdk.platform import ModelProviderState ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/ModelProviderType.mdx b/docs/development/reference/python-sdk/platform/ModelProviderType.mdx index 2206adef51..b187050453 100644 --- a/docs/development/reference/python-sdk/platform/ModelProviderType.mdx +++ b/docs/development/reference/python-sdk/platform/ModelProviderType.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelProviderType -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelProviderType +```py from agentstack_sdk.platform import ModelProviderType ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/ModelWithScore.mdx b/docs/development/reference/python-sdk/platform/ModelWithScore.mdx index 94cd7e1d6c..4a2e99fdb0 100644 --- a/docs/development/reference/python-sdk/platform/ModelWithScore.mdx +++ b/docs/development/reference/python-sdk/platform/ModelWithScore.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ModelWithScore -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelWithScore +```py from agentstack_sdk.platform import ModelWithScore ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/NoAction.mdx b/docs/development/reference/python-sdk/platform/NoAction.mdx index de4b43e225..6d9b3a3f1f 100644 --- a/docs/development/reference/python-sdk/platform/NoAction.mdx +++ b/docs/development/reference/python-sdk/platform/NoAction.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / NoAction -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / NoAction +```py from agentstack_sdk.platform import NoAction ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/PlatformClient.mdx b/docs/development/reference/python-sdk/platform/PlatformClient.mdx index fd7c9dc13e..aba4f6394c 100644 --- a/docs/development/reference/python-sdk/platform/PlatformClient.mdx +++ b/docs/development/reference/python-sdk/platform/PlatformClient.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / PlatformClient -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / PlatformClient +```py from agentstack_sdk.platform import PlatformClient ``` **Bases:** `AsyncClient` diff --git a/docs/development/reference/python-sdk/platform/Provider.mdx b/docs/development/reference/python-sdk/platform/Provider.mdx index 3c5ef6ba45..7bd0f148c9 100644 --- a/docs/development/reference/python-sdk/platform/Provider.mdx +++ b/docs/development/reference/python-sdk/platform/Provider.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Provider -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Provider +```py from agentstack_sdk.platform import Provider ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ProviderBuild.mdx b/docs/development/reference/python-sdk/platform/ProviderBuild.mdx index 07ed07a24a..14b667db9c 100644 --- a/docs/development/reference/python-sdk/platform/ProviderBuild.mdx +++ b/docs/development/reference/python-sdk/platform/ProviderBuild.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ProviderBuild -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ProviderBuild +```py from agentstack_sdk.platform import ProviderBuild ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx b/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx index 0eca1d7efe..5c29033686 100644 --- a/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx +++ b/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ProviderDiscovery -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ProviderDiscovery +```py from agentstack_sdk.platform import ProviderDiscovery ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx b/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx index abb3e4375c..64c939a1a1 100644 --- a/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx +++ b/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / ProviderErrorMessage -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ProviderErrorMessage +```py from agentstack_sdk.platform import ProviderErrorMessage ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx b/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx index 46cca7c830..1d40211930 100644 --- a/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx +++ b/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / SystemConfiguration -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / SystemConfiguration +```py from agentstack_sdk.platform import SystemConfiguration ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/UpdateProvider.mdx b/docs/development/reference/python-sdk/platform/UpdateProvider.mdx index 1b130e648b..15990085ea 100644 --- a/docs/development/reference/python-sdk/platform/UpdateProvider.mdx +++ b/docs/development/reference/python-sdk/platform/UpdateProvider.mdx @@ -10,8 +10,8 @@ description: "Will update provider specified by ID" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / UpdateProvider -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / UpdateProvider +```py from agentstack_sdk.platform import UpdateProvider ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/User.mdx b/docs/development/reference/python-sdk/platform/User.mdx index f79e792508..785ff3a1ce 100644 --- a/docs/development/reference/python-sdk/platform/User.mdx +++ b/docs/development/reference/python-sdk/platform/User.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / User -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / User +```py from agentstack_sdk.platform import User ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/UserFeedback.mdx b/docs/development/reference/python-sdk/platform/UserFeedback.mdx index 248bb96f15..7a7f2434d7 100644 --- a/docs/development/reference/python-sdk/platform/UserFeedback.mdx +++ b/docs/development/reference/python-sdk/platform/UserFeedback.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / UserFeedback -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / UserFeedback +```py from agentstack_sdk.platform import UserFeedback ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/UserRole.mdx b/docs/development/reference/python-sdk/platform/UserRole.mdx index 99b48d02b6..edcb0826a4 100644 --- a/docs/development/reference/python-sdk/platform/UserRole.mdx +++ b/docs/development/reference/python-sdk/platform/UserRole.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / UserRole -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / UserRole +```py from agentstack_sdk.platform import UserRole ``` **Bases:** `StrEnum` diff --git a/docs/development/reference/python-sdk/platform/Variables.mdx b/docs/development/reference/python-sdk/platform/Variables.mdx index 1d3c51eeaf..4c141bf32e 100644 --- a/docs/development/reference/python-sdk/platform/Variables.mdx +++ b/docs/development/reference/python-sdk/platform/Variables.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / Variables -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Variables +```py from agentstack_sdk.platform import Variables ``` **Bases:** `dict[str, str]` diff --git a/docs/development/reference/python-sdk/platform/VectorStore.mdx b/docs/development/reference/python-sdk/platform/VectorStore.mdx index 54c650b836..7341c03a7d 100644 --- a/docs/development/reference/python-sdk/platform/VectorStore.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStore.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStore -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStore +```py from agentstack_sdk.platform import VectorStore ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx b/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx index b46b5d6935..ead4940b3f 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreDocument -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreDocument +```py from agentstack_sdk.platform import VectorStoreDocument ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx b/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx index 232662e9b9..1c28ad9f41 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreItem -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreItem +```py from agentstack_sdk.platform import VectorStoreItem ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx b/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx index 5a64226889..1b2b8e8d30 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreSearchResult -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreSearchResult +```py from agentstack_sdk.platform import VectorStoreSearchResult ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx b/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx index 6c01c59918..c0660f0426 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VectorStoreStats -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreStats +```py from agentstack_sdk.platform import VectorStoreStats ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/VersionInfo.mdx b/docs/development/reference/python-sdk/platform/VersionInfo.mdx index 2d383e44a0..df837ed17b 100644 --- a/docs/development/reference/python-sdk/platform/VersionInfo.mdx +++ b/docs/development/reference/python-sdk/platform/VersionInfo.mdx @@ -10,8 +10,8 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / VersionInfo -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VersionInfo +```py from agentstack_sdk.platform import VersionInfo ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/platform/get_platform_client.mdx b/docs/development/reference/python-sdk/platform/get_platform_client.mdx index 2271e691de..71f1790884 100644 --- a/docs/development/reference/python-sdk/platform/get_platform_client.mdx +++ b/docs/development/reference/python-sdk/platform/get_platform_client.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / get_platform_client -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / get_platform_client +```py from agentstack_sdk.platform import get_platform_client ``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/set_platform_client.mdx b/docs/development/reference/python-sdk/platform/set_platform_client.mdx index 6249d3d290..005fe3a73d 100644 --- a/docs/development/reference/python-sdk/platform/set_platform_client.mdx +++ b/docs/development/reference/python-sdk/platform/set_platform_client.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / set_platform_client -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / set_platform_client +```py from agentstack_sdk.platform import set_platform_client ``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/use_platform_client.mdx b/docs/development/reference/python-sdk/platform/use_platform_client.mdx index 5ab4c19fd7..4a8bf57bf7 100644 --- a/docs/development/reference/python-sdk/platform/use_platform_client.mdx +++ b/docs/development/reference/python-sdk/platform/use_platform_client.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / use_platform_client -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / use_platform_client +```py from agentstack_sdk.platform import use_platform_client ``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/uuid_to_str.mdx b/docs/development/reference/python-sdk/platform/uuid_to_str.mdx index de19267a4b..3a4196cf85 100644 --- a/docs/development/reference/python-sdk/platform/uuid_to_str.mdx +++ b/docs/development/reference/python-sdk/platform/uuid_to_str.mdx @@ -10,15 +10,17 @@ description: "Convert UUID or str to str" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / uuid_to_str -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / uuid_to_str +```py from agentstack_sdk.platform import uuid_to_str ``` Convert UUID or str to str. ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `v` | `UUID | str` | — | | +| Name | Type | Default | +|------|------|---------| +| `v` | `UUID \| str` | — | + ## Returns `str` diff --git a/docs/development/reference/python-sdk/platform/validate_metadata.mdx b/docs/development/reference/python-sdk/platform/validate_metadata.mdx index 0f6cb78c48..18df7ca026 100644 --- a/docs/development/reference/python-sdk/platform/validate_metadata.mdx +++ b/docs/development/reference/python-sdk/platform/validate_metadata.mdx @@ -10,14 +10,16 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API](/development/reference/python-sdk/platform) / validate_metadata -```python +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / validate_metadata +```py from agentstack_sdk.platform import validate_metadata ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `metadata` | `dict[str, str | None]` | — | | +| Name | Type | Default | +|------|------|---------| +| `metadata` | `dict[str, str \| None]` | — | + ## Returns `dict[str, str | None]` diff --git a/docs/development/reference/python-sdk/server.mdx b/docs/development/reference/python-sdk/server.mdx index 3b7837695c..65df8e59ae 100644 --- a/docs/development/reference/python-sdk/server.mdx +++ b/docs/development/reference/python-sdk/server.mdx @@ -10,7 +10,7 @@ description: "Core server for creating and running A2A-compatible agents" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.server import Server ``` --- diff --git a/docs/development/reference/python-sdk/server/Agent.mdx b/docs/development/reference/python-sdk/server/Agent.mdx index 76ae2e8853..6983d327ba 100644 --- a/docs/development/reference/python-sdk/server/Agent.mdx +++ b/docs/development/reference/python-sdk/server/Agent.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / agent -```python +```py from agentstack_sdk.server import agent ``` Create an Agent function. @@ -43,8 +43,26 @@ Create an Agent function. :param version: The agent's own version number. The format is defined by the provider. ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `name` | `str | None` | — | || `description` | `str | None` | — | || `url` | `str` | `'http://invalid'` | || `additional_interfaces` | `list[AgentInterface] | None` | — | || `capabilities` | `AgentCapabilities | None` | — | || `default_input_modes` | `list[str] | None` | — | || `default_output_modes` | `list[str] | None` | — | || `detail` | `AgentDetail | None` | — | || `documentation_url` | `str | None` | — | || `icon_url` | `str | None` | — | || `preferred_transport` | `str | None` | — | || `provider` | `AgentProvider | None` | — | || `security` | `list[dict[str, list[str]]] | None` | — | || `security_schemes` | `dict[str, SecurityScheme] | None` | — | || `skills` | `list[AgentSkill] | None` | — | || `supports_authenticated_extended_card` | `bool | None` | — | || `version` | `str | None` | — | | +| Name | Type | Default | +|------|------|---------| +| `name` | `str \| None` | — | +| `description` | `str \| None` | — | +| `url` | `str` | `'http://invalid'` | +| `additional_interfaces` | `list[AgentInterface] \| None` | — | +| `capabilities` | `AgentCapabilities \| None` | — | +| `default_input_modes` | `list[str] \| None` | — | +| `default_output_modes` | `list[str] \| None` | — | +| `detail` | `AgentDetail \| None` | — | +| `documentation_url` | `str \| None` | — | +| `icon_url` | `str \| None` | — | +| `preferred_transport` | `str \| None` | — | +| `provider` | `AgentProvider \| None` | — | +| `security` | `list[dict[str, list[str]]] \| None` | — | +| `security_schemes` | `dict[str, SecurityScheme] \| None` | — | +| `skills` | `list[AgentSkill] \| None` | — | +| `supports_authenticated_extended_card` | `bool \| None` | — | +| `version` | `str \| None` | — | + ## Returns `Callable[[OriginalFnType], AgentFactory]` diff --git a/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx b/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx index 2cfa27813f..357031ad88 100644 --- a/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx +++ b/docs/development/reference/python-sdk/server/AgentExecuteFn.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / AgentExecuteFn -```python +```py from agentstack_sdk.server import AgentExecuteFn ``` **Bases:** `Protocol` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server/AgentRun.mdx b/docs/development/reference/python-sdk/server/AgentRun.mdx index bd0d65f16c..9e45ae5f3b 100644 --- a/docs/development/reference/python-sdk/server/AgentRun.mdx +++ b/docs/development/reference/python-sdk/server/AgentRun.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / AgentRun -```python +```py from agentstack_sdk.server import AgentRun ``` ## Class Attributes diff --git a/docs/development/reference/python-sdk/server/ContextStore.mdx b/docs/development/reference/python-sdk/server/ContextStore.mdx index 338b08b277..6b3147a1e1 100644 --- a/docs/development/reference/python-sdk/server/ContextStore.mdx +++ b/docs/development/reference/python-sdk/server/ContextStore.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / ContextStore -```python +```py from agentstack_sdk.server import ContextStore ``` **Bases:** `ABC` diff --git a/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx b/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx index 4d460539d3..0d0d789783 100644 --- a/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx +++ b/docs/development/reference/python-sdk/server/ContextStoreInstance.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / ContextStoreInstance -```python +```py from agentstack_sdk.server import ContextStoreInstance ``` **Bases:** `Protocol` diff --git a/docs/development/reference/python-sdk/server/Depends.mdx b/docs/development/reference/python-sdk/server/Depends.mdx index 42ef3f2a1b..b9d2401131 100644 --- a/docs/development/reference/python-sdk/server/Depends.mdx +++ b/docs/development/reference/python-sdk/server/Depends.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Depends -```python +```py from agentstack_sdk.server import Depends ``` ## Class Attributes diff --git a/docs/development/reference/python-sdk/server/Executor.mdx b/docs/development/reference/python-sdk/server/Executor.mdx index 226575adbc..7414df2b97 100644 --- a/docs/development/reference/python-sdk/server/Executor.mdx +++ b/docs/development/reference/python-sdk/server/Executor.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Executor -```python +```py from agentstack_sdk.server import Executor ``` **Bases:** `AgentExecutor` diff --git a/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx b/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx index fce8c76fb7..10723f95b7 100644 --- a/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx +++ b/docs/development/reference/python-sdk/server/InMemoryContextStore.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / InMemoryContextStore -```python +```py from agentstack_sdk.server import InMemoryContextStore ``` **Bases:** `ContextStore` diff --git a/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx b/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx index 271fe2ec37..d12e3ec8c1 100644 --- a/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx +++ b/docs/development/reference/python-sdk/server/MemoryContextStoreInstance.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / MemoryContextStoreInstance -```python +```py from agentstack_sdk.server import MemoryContextStoreInstance ``` **Bases:** `ContextStoreInstance` diff --git a/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx b/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx index b61e58de7f..62895c3724 100644 --- a/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx +++ b/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformAuthBackend -```python +```py from agentstack_sdk.server import PlatformAuthBackend ``` **Bases:** `SdkAuthenticationBackend` diff --git a/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx b/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx index 766f5c216e..e3432fb7e7 100644 --- a/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx +++ b/docs/development/reference/python-sdk/server/PlatformAuthenticatedUser.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformAuthenticatedUser -```python +```py from agentstack_sdk.server import PlatformAuthenticatedUser ``` **Bases:** `User , BaseUser` diff --git a/docs/development/reference/python-sdk/server/PlatformContextStore.mdx b/docs/development/reference/python-sdk/server/PlatformContextStore.mdx index 97f94353a6..6efc544fa4 100644 --- a/docs/development/reference/python-sdk/server/PlatformContextStore.mdx +++ b/docs/development/reference/python-sdk/server/PlatformContextStore.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformContextStore -```python +```py from agentstack_sdk.server import PlatformContextStore ``` **Bases:** `ContextStore` diff --git a/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx b/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx index 60231b878f..efd1e75d80 100644 --- a/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx +++ b/docs/development/reference/python-sdk/server/PlatformContextStoreInstance.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / PlatformContextStoreInstance -```python +```py from agentstack_sdk.server import PlatformContextStoreInstance ``` **Bases:** `ContextStoreInstance` diff --git a/docs/development/reference/python-sdk/server/RunContext.mdx b/docs/development/reference/python-sdk/server/RunContext.mdx index 2293590bca..ec613a846f 100644 --- a/docs/development/reference/python-sdk/server/RunContext.mdx +++ b/docs/development/reference/python-sdk/server/RunContext.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / RunContext -```python +```py from agentstack_sdk.server import RunContext ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/server/Server.mdx b/docs/development/reference/python-sdk/server/Server.mdx index 798c30dade..23cddfe9ff 100644 --- a/docs/development/reference/python-sdk/server/Server.mdx +++ b/docs/development/reference/python-sdk/server/Server.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Server -```python +```py from agentstack_sdk.server import Server ``` ## Class Attributes diff --git a/docs/development/reference/python-sdk/server/cancel_task.mdx b/docs/development/reference/python-sdk/server/cancel_task.mdx index 56a70a0983..0f3625ceb1 100644 --- a/docs/development/reference/python-sdk/server/cancel_task.mdx +++ b/docs/development/reference/python-sdk/server/cancel_task.mdx @@ -11,11 +11,12 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / cancel_task -```python +```py from agentstack_sdk.server import cancel_task ``` Labels: `async` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `task` | `asyncio.Task` | — | | \ No newline at end of file +| Name | Type | Default | +|------|------|---------| +| `task` | `asyncio.Task` | — | diff --git a/docs/development/reference/python-sdk/server/close_queue.mdx b/docs/development/reference/python-sdk/server/close_queue.mdx index 4facb8ea76..644308390e 100644 --- a/docs/development/reference/python-sdk/server/close_queue.mdx +++ b/docs/development/reference/python-sdk/server/close_queue.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / close_queue -```python +```py from agentstack_sdk.server import close_queue ``` Labels: `async` @@ -22,5 +22,8 @@ until all queue events are processed. This can have unexpected side effects, we independently and then removing it from queue_manager ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `queue_manager` | `QueueManager` | — | || `queue_name` | `str` | — | || `immediate` | `bool` | `False` | | \ No newline at end of file +| Name | Type | Default | +|------|------|---------| +| `queue_manager` | `QueueManager` | — | +| `queue_name` | `str` | — | +| `immediate` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/server/configure_telemetry.mdx b/docs/development/reference/python-sdk/server/configure_telemetry.mdx index e6945e77ae..425ec059a1 100644 --- a/docs/development/reference/python-sdk/server/configure_telemetry.mdx +++ b/docs/development/reference/python-sdk/server/configure_telemetry.mdx @@ -11,14 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / configure_telemetry -```python +```py from agentstack_sdk.server import configure_telemetry ``` Utility that configures opentelemetry with OTLP exporter and FastAPI instrumentation ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `app` | `FastAPI` | — | | +| Name | Type | Default | +|------|------|---------| +| `app` | `FastAPI` | — | + ## Returns `None` diff --git a/docs/development/reference/python-sdk/server/create_app.mdx b/docs/development/reference/python-sdk/server/create_app.mdx index 127a8845d9..0a7c4edea6 100644 --- a/docs/development/reference/python-sdk/server/create_app.mdx +++ b/docs/development/reference/python-sdk/server/create_app.mdx @@ -11,13 +11,26 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / create_app -```python +```py from agentstack_sdk.server import create_app ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `agent` | `Agent` | — | || `task_store` | `TaskStore | None` | — | || `context_store` | `ContextStore | None` | — | || `queue_manager` | `QueueManager | None` | — | || `push_config_store` | `PushNotificationConfigStore | None` | — | || `push_sender` | `PushNotificationSender | None` | — | || `request_context_builder` | `RequestContextBuilder | None` | — | || `lifespan` | `Lifespan[AppType] | None` | — | || `dependencies` | `list[Depends] | None` | — | || `override_interfaces` | `bool` | `True` | || `task_timeout` | `timedelta` | `timedelta(minutes=10)` | || `kwargs` | — | `{}` | | +| Name | Type | Default | +|------|------|---------| +| `agent` | `Agent` | — | +| `task_store` | `TaskStore \| None` | — | +| `context_store` | `ContextStore \| None` | — | +| `queue_manager` | `QueueManager \| None` | — | +| `push_config_store` | `PushNotificationConfigStore \| None` | — | +| `push_sender` | `PushNotificationSender \| None` | — | +| `request_context_builder` | `RequestContextBuilder \| None` | — | +| `lifespan` | `Lifespan[AppType] \| None` | — | +| `dependencies` | `list[Depends] \| None` | — | +| `override_interfaces` | `bool` | `True` | +| `task_timeout` | `timedelta` | `timedelta(minutes=10)` | +| `kwargs` | — | `{}` | + ## Returns `FastAPI` diff --git a/docs/development/reference/python-sdk/server/discover_jwks.mdx b/docs/development/reference/python-sdk/server/discover_jwks.mdx index ddf8990e40..24a8d4d328 100644 --- a/docs/development/reference/python-sdk/server/discover_jwks.mdx +++ b/docs/development/reference/python-sdk/server/discover_jwks.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / discover_jwks -```python +```py from agentstack_sdk.server import discover_jwks ``` Labels: `async` diff --git a/docs/development/reference/python-sdk/server/extract_dependencies.mdx b/docs/development/reference/python-sdk/server/extract_dependencies.mdx index 8e87ce552b..32a4c5e2d8 100644 --- a/docs/development/reference/python-sdk/server/extract_dependencies.mdx +++ b/docs/development/reference/python-sdk/server/extract_dependencies.mdx @@ -11,13 +11,15 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / extract_dependencies -```python +```py from agentstack_sdk.server import extract_dependencies ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `fn` | `Callable[..., Any]` | — | | +| Name | Type | Default | +|------|------|---------| +| `fn` | `Callable[..., Any]` | — | + ## Returns `dict[str, Depends]` diff --git a/docs/development/reference/python-sdk/types.mdx b/docs/development/reference/python-sdk/types.mdx index 9621371619..c745b4036d 100644 --- a/docs/development/reference/python-sdk/types.mdx +++ b/docs/development/reference/python-sdk/types.mdx @@ -10,7 +10,7 @@ description: "Core type definitions and base classes" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.types import SdkAuthenticationBackend ``` --- diff --git a/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx b/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx index 32706d2679..bdebad22fd 100644 --- a/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx +++ b/docs/development/reference/python-sdk/types/SdkAuthenticationBackend.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [SDK Types](/development/reference/python-sdk/types) / SdkAuthenticationBackend -```python +```py from agentstack_sdk.types import SdkAuthenticationBackend ``` **Bases:** `AuthenticationBackend , abc.ABC` diff --git a/docs/development/reference/python-sdk/util.mdx b/docs/development/reference/python-sdk/util.mdx index 8c8b12fe35..72c69c82aa 100644 --- a/docs/development/reference/python-sdk/util.mdx +++ b/docs/development/reference/python-sdk/util.mdx @@ -10,7 +10,7 @@ description: "Utility helpers" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -```python +```py from agentstack_sdk.util import resource_context ``` --- diff --git a/docs/development/reference/python-sdk/util/BearerAuth.mdx b/docs/development/reference/python-sdk/util/BearerAuth.mdx index ec7005bfdd..7956dcab59 100644 --- a/docs/development/reference/python-sdk/util/BearerAuth.mdx +++ b/docs/development/reference/python-sdk/util/BearerAuth.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / BearerAuth -```python +```py from agentstack_sdk.util import BearerAuth ``` **Bases:** `Auth` diff --git a/docs/development/reference/python-sdk/util/ColoredFormatter.mdx b/docs/development/reference/python-sdk/util/ColoredFormatter.mdx index 5c25910245..ec6d0f3c4c 100644 --- a/docs/development/reference/python-sdk/util/ColoredFormatter.mdx +++ b/docs/development/reference/python-sdk/util/ColoredFormatter.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / ColoredFormatter -```python +```py from agentstack_sdk.util import ColoredFormatter ``` **Bases:** `logging.Formatter` diff --git a/docs/development/reference/python-sdk/util/LoadedFile.mdx b/docs/development/reference/python-sdk/util/LoadedFile.mdx index 7efad70adc..5d81e42a9e 100644 --- a/docs/development/reference/python-sdk/util/LoadedFile.mdx +++ b/docs/development/reference/python-sdk/util/LoadedFile.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / LoadedFile -```python +```py from agentstack_sdk.util import LoadedFile ``` **Bases:** `Protocol` diff --git a/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx b/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx index 40ee243499..f8fac34279 100644 --- a/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx +++ b/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / LoadedFileWithBytes -```python +```py from agentstack_sdk.util import LoadedFileWithBytes ``` **Bases:** `LoadedFile` diff --git a/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx b/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx index d94fc2f597..705faa30c8 100644 --- a/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx +++ b/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / LoadedFileWithUri -```python +```py from agentstack_sdk.util import LoadedFileWithUri ``` ## Class Attributes diff --git a/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx b/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx index fea00d6a6c..9fe24decfc 100644 --- a/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx +++ b/docs/development/reference/python-sdk/util/PlatformFileUrl.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / PlatformFileUrl -```python +```py from agentstack_sdk.util import PlatformFileUrl ``` **Bases:** `AnyUrl` diff --git a/docs/development/reference/python-sdk/util/SecureBaseModel.mdx b/docs/development/reference/python-sdk/util/SecureBaseModel.mdx index a22e6b4566..96662c8ad1 100644 --- a/docs/development/reference/python-sdk/util/SecureBaseModel.mdx +++ b/docs/development/reference/python-sdk/util/SecureBaseModel.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / SecureBaseModel -```python +```py from agentstack_sdk.util import SecureBaseModel ``` **Bases:** `BaseModel` diff --git a/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx b/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx index 9bffe49f79..fb24b56d46 100644 --- a/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx +++ b/docs/development/reference/python-sdk/util/apply_compatibility_monkey_patching.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / apply_compatibility_monkey_patching -```python +```py from agentstack_sdk.util import apply_compatibility_monkey_patching ``` Workaround for Pydantic + Python 3.14 issue where TypeAdapter[ChatModelKwargs] is not fully defined. diff --git a/docs/development/reference/python-sdk/util/configure_logger.mdx b/docs/development/reference/python-sdk/util/configure_logger.mdx index b03abf50d5..e408b7fa5a 100644 --- a/docs/development/reference/python-sdk/util/configure_logger.mdx +++ b/docs/development/reference/python-sdk/util/configure_logger.mdx @@ -11,13 +11,15 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / configure_logger -```python +```py from agentstack_sdk.util import configure_logger ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `level` | `int | str | None` | — | | +| Name | Type | Default | +|------|------|---------| +| `level` | `int \| str \| None` | — | + ## Returns `None` diff --git a/docs/development/reference/python-sdk/util/extract_messages.mdx b/docs/development/reference/python-sdk/util/extract_messages.mdx index 1e72c6a87a..025ffab409 100644 --- a/docs/development/reference/python-sdk/util/extract_messages.mdx +++ b/docs/development/reference/python-sdk/util/extract_messages.mdx @@ -11,13 +11,15 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / extract_messages -```python +```py from agentstack_sdk.util import extract_messages ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `exc` | `BaseException` | — | | +| Name | Type | Default | +|------|------|---------| +| `exc` | `BaseException` | — | + ## Returns `list[tuple[str, str]]` diff --git a/docs/development/reference/python-sdk/util/filter_dict.mdx b/docs/development/reference/python-sdk/util/filter_dict.mdx index d3276db242..7e0a6368f6 100644 --- a/docs/development/reference/python-sdk/util/filter_dict.mdx +++ b/docs/development/reference/python-sdk/util/filter_dict.mdx @@ -11,10 +11,11 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / filter_dict -```python +```py from agentstack_sdk.util import filter_dict ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `d` | `dict` | — | | \ No newline at end of file +| Name | Type | Default | +|------|------|---------| +| `d` | `dict` | — | diff --git a/docs/development/reference/python-sdk/util/flatten_dict.mdx b/docs/development/reference/python-sdk/util/flatten_dict.mdx index 521f4e6954..c388a5fd78 100644 --- a/docs/development/reference/python-sdk/util/flatten_dict.mdx +++ b/docs/development/reference/python-sdk/util/flatten_dict.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / flatten_dict -```python +```py from agentstack_sdk.util import flatten_dict ``` Flatten nested dict → OpenTelemetry-compatible flat dict. @@ -20,8 +20,14 @@ Flatten nested dict → OpenTelemetry-compatible flat dict. - None values are skipped by default ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `d` | `Mapping[str, Any]` | — | || `parent_key` | `str` | `''` | || `sep` | `str` | `'.'` | || `skip_none` | `bool` | `True` | || `max_depth` | `int | None` | — | | +| Name | Type | Default | +|------|------|---------| +| `d` | `Mapping[str, Any]` | — | +| `parent_key` | `str` | `''` | +| `sep` | `str` | `'.'` | +| `skip_none` | `bool` | `True` | +| `max_depth` | `int \| None` | — | + ## Returns `dict[str, Any]` diff --git a/docs/development/reference/python-sdk/util/load_file.mdx b/docs/development/reference/python-sdk/util/load_file.mdx index c1b296178d..f4b10580e4 100644 --- a/docs/development/reference/python-sdk/util/load_file.mdx +++ b/docs/development/reference/python-sdk/util/load_file.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / load_file -```python +```py from agentstack_sdk.util import load_file ``` Labels: `async` @@ -19,8 +19,12 @@ Labels: `async` Otherwise, they are only available after calling the '(a)read' method. ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `part` | `FilePart` | — | || `stream` | `bool` | `False` | || `client` | `AsyncClient | None` | — | | +| Name | Type | Default | +|------|------|---------| +| `part` | `FilePart` | — | +| `stream` | `bool` | `False` | +| `client` | `AsyncClient \| None` | — | + ## Returns `AsyncIterator[LoadedFile]` diff --git a/docs/development/reference/python-sdk/util/parse_stream.mdx b/docs/development/reference/python-sdk/util/parse_stream.mdx index 74ad56e194..bea605056d 100644 --- a/docs/development/reference/python-sdk/util/parse_stream.mdx +++ b/docs/development/reference/python-sdk/util/parse_stream.mdx @@ -11,14 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / parse_stream -```python +```py from agentstack_sdk.util import parse_stream ``` Labels: `async` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `response` | `Response` | — | | +| Name | Type | Default | +|------|------|---------| +| `response` | `Response` | — | + ## Returns `AsyncIterator[dict[str, Any]]` diff --git a/docs/development/reference/python-sdk/util/redact_dict.mdx b/docs/development/reference/python-sdk/util/redact_dict.mdx index 946f750fb9..7f8aa2a787 100644 --- a/docs/development/reference/python-sdk/util/redact_dict.mdx +++ b/docs/development/reference/python-sdk/util/redact_dict.mdx @@ -11,13 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_dict -```python +```py from agentstack_sdk.util import redact_dict ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `v` | `dict[str, str]` | — | || `info` | `SerializationInfo` | — | | +| Name | Type | Default | +|------|------|---------| +| `v` | `dict[str, str]` | — | +| `info` | `SerializationInfo` | — | + ## Returns `dict[str, str]` diff --git a/docs/development/reference/python-sdk/util/redact_secret.mdx b/docs/development/reference/python-sdk/util/redact_secret.mdx index 12723cf482..3e134777df 100644 --- a/docs/development/reference/python-sdk/util/redact_secret.mdx +++ b/docs/development/reference/python-sdk/util/redact_secret.mdx @@ -11,13 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_secret -```python +```py from agentstack_sdk.util import redact_secret ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `v` | `Secret | SecretStr | SecretBytes` | — | || `info` | `SerializationInfo` | — | | +| Name | Type | Default | +|------|------|---------| +| `v` | `Secret \| SecretStr \| SecretBytes` | — | +| `info` | `SerializationInfo` | — | + ## Returns `Secret | SecretStr | SecretBytes | str | bytes` diff --git a/docs/development/reference/python-sdk/util/redact_str.mdx b/docs/development/reference/python-sdk/util/redact_str.mdx index 5c067582ca..e1df776876 100644 --- a/docs/development/reference/python-sdk/util/redact_str.mdx +++ b/docs/development/reference/python-sdk/util/redact_str.mdx @@ -11,13 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_str -```python +```py from agentstack_sdk.util import redact_str ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `v` | `str` | — | || `info` | `SerializationInfo` | — | | +| Name | Type | Default | +|------|------|---------| +| `v` | `str` | — | +| `info` | `SerializationInfo` | — | + ## Returns `str` diff --git a/docs/development/reference/python-sdk/util/redact_url.mdx b/docs/development/reference/python-sdk/util/redact_url.mdx index 6154be8167..d7ee6a6cae 100644 --- a/docs/development/reference/python-sdk/util/redact_url.mdx +++ b/docs/development/reference/python-sdk/util/redact_url.mdx @@ -11,13 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / redact_url -```python +```py from agentstack_sdk.util import redact_url ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `v` | `AnyUrl` | — | || `info` | `SerializationInfo` | — | | +| Name | Type | Default | +|------|------|---------| +| `v` | `AnyUrl` | — | +| `info` | `SerializationInfo` | — | + ## Returns `AnyUrl` diff --git a/docs/development/reference/python-sdk/util/resource_context.mdx b/docs/development/reference/python-sdk/util/resource_context.mdx index 401fe239f4..6b9b46185b 100644 --- a/docs/development/reference/python-sdk/util/resource_context.mdx +++ b/docs/development/reference/python-sdk/util/resource_context.mdx @@ -11,13 +11,16 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / resource_context -```python +```py from agentstack_sdk.util import resource_context ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `factory` | `Callable[P, T]` | — | || `default_factory` | `Callable[[], T]` | — | | +| Name | Type | Default | +|------|------|---------| +| `factory` | `Callable[P, T]` | — | +| `default_factory` | `Callable[[], T]` | — | + ## Returns `tuple[typing.Callable[[], T], typing.Callable[P, contextlib.AbstractContextManager[T]]]` diff --git a/docs/development/reference/python-sdk/util/should_redact.mdx b/docs/development/reference/python-sdk/util/should_redact.mdx index 4fc8baec00..fe4f59d35e 100644 --- a/docs/development/reference/python-sdk/util/should_redact.mdx +++ b/docs/development/reference/python-sdk/util/should_redact.mdx @@ -11,13 +11,15 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / should_redact -```python +```py from agentstack_sdk.util import should_redact ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `info` | `SerializationInfo` | — | | +| Name | Type | Default | +|------|------|---------| +| `info` | `SerializationInfo` | — | + ## Returns `bool` diff --git a/docs/development/reference/python-sdk/util/should_reveal.mdx b/docs/development/reference/python-sdk/util/should_reveal.mdx index 6864bf59a4..2e3b26c5b1 100644 --- a/docs/development/reference/python-sdk/util/should_reveal.mdx +++ b/docs/development/reference/python-sdk/util/should_reveal.mdx @@ -11,13 +11,15 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / should_reveal -```python +```py from agentstack_sdk.util import should_reveal ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `info` | `SerializationInfo` | — | | +| Name | Type | Default | +|------|------|---------| +| `info` | `SerializationInfo` | — | + ## Returns `bool` diff --git a/docs/development/reference/python-sdk/util/trace_class.mdx b/docs/development/reference/python-sdk/util/trace_class.mdx index 28e86957ac..0c9cb8ceab 100644 --- a/docs/development/reference/python-sdk/util/trace_class.mdx +++ b/docs/development/reference/python-sdk/util/trace_class.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / trace_class -```python +```py from agentstack_sdk.util import trace_class ``` A class decorator to automatically trace specified methods of a class. @@ -64,8 +64,13 @@ Example: ``` ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `include_list` | `list[str] | None` | — | || `exclude_list` | `list[str] | None` | — | || `kind` | `SpanKind` | `SpanKind.INTERNAL` | || `attributes` | `dict[str, Any] | None` | — | | +| Name | Type | Default | +|------|------|---------| +| `include_list` | `list[str] \| None` | — | +| `exclude_list` | `list[str] \| None` | — | +| `kind` | `SpanKind` | `SpanKind.INTERNAL` | +| `attributes` | `dict[str, Any] \| None` | — | + ## Returns `Callable` diff --git a/docs/development/reference/python-sdk/util/trace_function.mdx b/docs/development/reference/python-sdk/util/trace_function.mdx index 835671a1dd..5a89371bcf 100644 --- a/docs/development/reference/python-sdk/util/trace_function.mdx +++ b/docs/development/reference/python-sdk/util/trace_function.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / trace_function -```python +```py from agentstack_sdk.util import trace_function ``` A decorator to automatically trace a function call with OpenTelemetry. @@ -58,8 +58,14 @@ Returns: decorator if ``func`` is None. ## Parameters -| Name | Type | Default | Description | -|------|------|---------|-------------|| `func` | `Callable | None` | — | || `span_name` | `str | None` | — | || `kind` | `SpanKind` | `SpanKind.INTERNAL` | || `attributes` | `dict[str, Any] | None` | — | || `attribute_extractor` | `Callable | None` | — | | +| Name | Type | Default | +|------|------|---------| +| `func` | `Callable \| None` | — | +| `span_name` | `str \| None` | — | +| `kind` | `SpanKind` | `SpanKind.INTERNAL` | +| `attributes` | `dict[str, Any] \| None` | — | +| `attribute_extractor` | `Callable \| None` | — | + ## Returns `Callable` diff --git a/docs/development/reference/python-sdk/util/utc_now.mdx b/docs/development/reference/python-sdk/util/utc_now.mdx index b6ec652afc..1fb2add5bc 100644 --- a/docs/development/reference/python-sdk/util/utc_now.mdx +++ b/docs/development/reference/python-sdk/util/utc_now.mdx @@ -11,7 +11,7 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [Utilities](/development/reference/python-sdk/util) / utc_now -```python +```py from agentstack_sdk.util import utc_now ``` ## Returns diff --git a/docs/docs.json b/docs/docs.json index 6ef6626196..d5284ab801 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -168,7 +168,15 @@ } ] }, - "development/reference/python-sdk/platform", + { + "group": "Platform API", + "pages": [ + "development/reference/python-sdk/platform-idx", + "development/reference/python-sdk/platform", + "development/reference/python-sdk/platform-common", + "development/reference/python-sdk/platform-context" + ] + }, "development/reference/python-sdk/types", "development/reference/python-sdk/util" ] From 16db4e1ef285f80efe2aba1f3d0f79866133b5ff Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Wed, 4 Mar 2026 09:51:14 +0100 Subject: [PATCH 4/8] bredcrumbs Signed-off-by: Jan Jeliga --- apps/agentstack-sdk-py/docs/generate_docs.py | 85 ++++++++---- .../docs/introspect_exports.py | 123 +++++++++--------- .../docs/templates/module.mdx.j2 | 5 + .../a2a/extensions/tools/exceptions.py | 1 + .../src/agentstack_sdk/util/pydantic.py | 8 +- .../python-sdk/a2a-auth-oauth-storage.mdx | 2 + .../MemoryTokenStorage.mdx | 2 +- .../MemoryTokenStorageFactory.mdx | 2 +- .../TokenStorageFactory.mdx | 2 +- .../reference/python-sdk/a2a-auth-oauth.mdx | 2 + .../python-sdk/a2a-auth-oauth/AuthRequest.mdx | 2 +- .../a2a-auth-oauth/AuthResponse.mdx | 2 +- .../python-sdk/a2a-auth-oauth/OAuthDemand.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionClient.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionMetadata.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionParams.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionServer.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionSpec.mdx | 2 +- .../a2a-auth-oauth/OAuthFulfillment.mdx | 2 +- .../reference/python-sdk/a2a-auth-secrets.mdx | 2 + .../a2a-auth-secrets/SecretDemand.mdx | 2 +- .../a2a-auth-secrets/SecretFulfillment.mdx | 2 +- .../SecretsExtensionClient.mdx | 2 +- .../SecretsExtensionServer.mdx | 2 +- .../a2a-auth-secrets/SecretsExtensionSpec.mdx | 2 +- .../SecretsServiceExtensionMetadata.mdx | 2 +- .../SecretsServiceExtensionParams.mdx | 2 +- .../reference/python-sdk/a2a-auth.mdx | 3 +- .../reference/python-sdk/a2a-common.mdx | 2 + .../reference/python-sdk/a2a-interactions.mdx | 2 + .../reference/python-sdk/a2a-services.mdx | 2 + .../reference/python-sdk/a2a-tools.mdx | 2 + .../reference/python-sdk/a2a-ui.mdx | 2 + .../reference/python-sdk/platform-common.mdx | 2 + .../reference/python-sdk/platform-context.mdx | 2 + .../reference/python-sdk/platform.mdx | 2 + .../python-sdk/platform/AddProvider.mdx | 2 +- .../platform/BuildConfiguration.mdx | 2 +- ...erver-middleware-platform-auth-backend.mdx | 32 +++++ .../PlatformAuthBackend.mdx | 61 +++++++++ .../PlatformAuthenticatedUser.mdx | 42 ++++++ .../discover_jwks.mdx | 21 +++ .../server-store-memory-context-store.mdx | 26 ++++ .../InMemoryContextStore.mdx | 47 +++++++ .../MemoryContextStoreInstance.mdx | 66 ++++++++++ .../server-store-platform-context-store.mdx | 26 ++++ .../PlatformContextStore.mdx | 44 +++++++ .../PlatformContextStoreInstance.mdx | 61 +++++++++ .../reference/python-sdk/server.mdx | 12 ++ .../reference/python-sdk/server/Agent.mdx | 32 ++--- .../python-sdk/server/PlatformAuthBackend.mdx | 2 +- .../python-sdk/server/create_app.mdx | 16 +-- .../reference/python-sdk/types.mdx | 1 + .../development/reference/python-sdk/util.mdx | 1 + .../python-sdk/util/ColoredFormatter.mdx | 2 +- .../python-sdk/util/configure_logger.mdx | 2 +- .../python-sdk/util/flatten_dict.mdx | 2 +- .../reference/python-sdk/util/load_file.mdx | 2 +- .../reference/python-sdk/util/trace_class.mdx | 6 +- .../python-sdk/util/trace_function.mdx | 8 +- docs/docs.json | 7 +- 61 files changed, 662 insertions(+), 146 deletions(-) create mode 100644 docs/development/reference/python-sdk/server-middleware-platform-auth-backend.mdx create mode 100644 docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx create mode 100644 docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthenticatedUser.mdx create mode 100644 docs/development/reference/python-sdk/server-middleware-platform-auth-backend/discover_jwks.mdx create mode 100644 docs/development/reference/python-sdk/server-store-memory-context-store.mdx create mode 100644 docs/development/reference/python-sdk/server-store-memory-context-store/InMemoryContextStore.mdx create mode 100644 docs/development/reference/python-sdk/server-store-memory-context-store/MemoryContextStoreInstance.mdx create mode 100644 docs/development/reference/python-sdk/server-store-platform-context-store.mdx create mode 100644 docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStore.mdx create mode 100644 docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStoreInstance.mdx diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py index f9349fbdba..61752150b0 100644 --- a/apps/agentstack-sdk-py/docs/generate_docs.py +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -73,6 +73,8 @@ # import_path – Python import path shown in the code snippet # submodule_cards – optional list of child modules rendered as a card grid # group_by_origin – split items into sections per origin sub-module (used for platform) + +# TODO: This must be updated when the imports logic and structure changes, for example if we directly populate some __init__.py file instead of importing directly from some .py file PAGE_CONFIG: list[dict] = [ # ── server ──────────────────────────────────────────────────────────────── { @@ -81,6 +83,32 @@ "title": "Server", "description": "Core server for creating and running A2A-compatible agents", "import_path": "agentstack_sdk.server", + "submodule_cards": [ + {"title": "Middleware", "filename": "server-middleware-platform-auth-backend", "description": "Platform authentication middleware"}, + {"title": "Memory context store", "filename": "server-store-memory-context-store", "description": "Context management using in-memory storage"}, + {"title": "Platform context store", "filename": "server-store-platform-context-store", "description": "Context management using platform storage"}, + ], + }, + { + "json_key": "agentstack_sdk.server.middleware.platform_auth_backend", + "filename": "server-middleware-platform-auth-backend", + "title": "Server Middleware Platform Auth Backend", + "description": "Core server for creating and running A2A-compatible agents", + "import_path": "agentstack_sdk.server.middleware.platform_auth_backend", + }, + { + "json_key": "agentstack_sdk.server.store.memory_context_store", + "filename": "server-store-memory-context-store", + "title": "Server Memory Context Store", + "description": "In-memory context store for the server", + "import_path": "agentstack_sdk.server.store.memory_context_store", + }, + { + "json_key": "agentstack_sdk.server.store.platform_context_store", + "filename": "server-store-platform-context-store", + "title": "Server Platform Context Store", + "description": "Platform context store for the server", + "import_path": "agentstack_sdk.server.store.platform_context_store", }, # ── a2a (index, items live in sub-pages) ────────────────────────────────── { @@ -92,8 +120,16 @@ "submodule_cards": [ {"title": "Auth", "filename": "a2a-auth", "description": "OAuth and secrets authentication"}, {"title": "Common", "filename": "a2a-common", "description": "Shared base classes and form types"}, - {"title": "Interactions", "filename": "a2a-interactions", "description": "Human-in-the-loop interaction extensions"}, - {"title": "Services", "filename": "a2a-services", "description": "LLM, embedding, MCP, and platform services"}, + { + "title": "Interactions", + "filename": "a2a-interactions", + "description": "Human-in-the-loop interaction extensions", + }, + { + "title": "Services", + "filename": "a2a-services", + "description": "LLM, embedding, MCP, and platform services", + }, {"title": "Tools", "filename": "a2a-tools", "description": "Tool call approval extensions"}, {"title": "UI", "filename": "a2a-ui", "description": "Rich UI component extensions"}, ], @@ -102,12 +138,16 @@ { "json_key": None, "filename": "a2a-auth", - "title": "Auth Extensions", + "title": "Auth Extensions Overview", "description": "OAuth and secrets authentication extensions", "import_path": "agentstack_sdk.a2a.extensions.auth", "submodule_cards": [ {"title": "Extensions", "filename": "a2a-auth-oauth", "description": "OAuth 2.0 flow extensions"}, - {"title": "Storage", "filename": "a2a-auth-oauth-storage", "description": "OAuth 2.0 flow storage extensions"}, + { + "title": "Storage", + "filename": "a2a-auth-oauth-storage", + "description": "OAuth 2.0 flow storage extensions", + }, {"title": "Secrets", "filename": "a2a-auth-secrets", "description": "Secrets injection extensions"}, ], }, @@ -231,7 +271,7 @@ ] # --------------------------------------------------------------------------- -# Jinja2 custom filters +# Jinja2 custom transformations # --------------------------------------------------------------------------- _TYPE_PREFIXES = ( @@ -281,14 +321,12 @@ def _extra_lines(text: str | None) -> str: return "\n".join(lines[1:]).strip() if len(lines) > 1 else "" -def _sig_params(params: list[dict] | None, max_params: int | None = None) -> str: +def _sig_params(params: list[dict] | None, max_params: int = 5) -> str: """Parameter names only — keeps accordion titles short.""" if not params: return "" - if max_params is not None: - return ", ".join(p["name"] for p in params[:max_params]) + ("..." if len(params) > max_params else "") - else: - return ", ".join(p["name"] for p in params) + + return ", ".join(p["name"] for p in params[:max_params]) + ("..." if len(params) > max_params else "") def _truncate_val(val: str | None, max_len: int = 40) -> str: @@ -366,8 +404,10 @@ def _symbol_import_path(item: dict) -> str: """Best import path to use on a symbol's own page.""" origin = item.get("origin", "") longest = _find_longest_matching_json_key(origin) + if longest: return _JSON_KEY_TO_IMPORT_PATH[longest] + # Fallback: use origin directly return origin @@ -387,8 +427,6 @@ def _symbol_page_parent_title(parent_filename: str) -> str: return _FILENAME_TO_TITLE.get(parent_filename, parent_filename.replace("-", " ").title()) - - # --------------------------------------------------------------------------- # Item helpers # --------------------------------------------------------------------------- @@ -397,7 +435,9 @@ def _symbol_page_parent_title(parent_filename: str) -> str: def _split_items(items: list[dict]) -> tuple[list[dict], list[dict], list[dict]]: classes = sorted([i for i in items if i.get("kind") == "class"], key=lambda i: i.get("name", "")) functions = sorted([i for i in items if i.get("kind") == "function"], key=lambda i: i.get("name", "")) - constants = sorted([i for i in items if i.get("kind") not in ("class", "function")], key=lambda i: i.get("name", "")) + constants = sorted( + [i for i in items if i.get("kind") not in ("class", "function")], key=lambda i: i.get("name", "") + ) return classes, functions, constants @@ -405,7 +445,7 @@ def _origin_submodule(item: dict, base_key: str) -> str: origin = item.get("origin", "") prefix = base_key + "." if origin.startswith(prefix): - return origin[len(prefix):].split(".")[0] + return origin[len(prefix) :].split(".")[0] return "" @@ -491,6 +531,9 @@ def render_page(env: Environment, cfg: dict, data: dict, version: str) -> str: all_functions = [f for g in groups for f in g["functions"]] import_example = _import_example(import_path, all_classes, all_functions) if items else "" + parent_filename = _FILENAME_TO_PARENT.get(cfg["filename"], "") + breadcrumb_ancestors = _symbol_breadcrumb_ancestors(parent_filename) if parent_filename else [] + tmpl = env.get_template("module.mdx.j2") return tmpl.render( autogen_warning=AUTOGEN_WARNING, @@ -502,6 +545,7 @@ def render_page(env: Environment, cfg: dict, data: dict, version: str) -> str: groups=groups, base_href=base_href, symbol_base_href=symbol_base_href, + breadcrumb_ancestors=breadcrumb_ancestors, ) @@ -544,7 +588,6 @@ def render_function_page( ) - # --------------------------------------------------------------------------- # Main # --------------------------------------------------------------------------- @@ -552,7 +595,9 @@ def render_function_page( def main() -> None: _build_module_maps() - parser = argparse.ArgumentParser(description="Generate Python SDK reference docs (MDX) from exports_structure.json.") + parser = argparse.ArgumentParser( + description="Generate Python SDK reference docs (MDX) from exports_structure.json." + ) parser.add_argument( "--json-file", type=Path, @@ -577,8 +622,7 @@ def main() -> None: if not json_file.exists(): raise FileNotFoundError( - f"exports_structure.json not found at {json_file}.\n" - "Run `mise x -- uv run introspect_exports.py` first." + f"exports_structure.json not found at {json_file}.\nRun `mise x -- uv run introspect_exports.py` first." ) data = json.loads(json_file.read_text()) @@ -637,10 +681,7 @@ def main() -> None: symbol_count += 1 module_count = 1 + len(PAGE_CONFIG) - print( - f"\nGenerated {module_count} module pages + {symbol_count} symbol pages" - f" in {version}/reference/python-sdk/" - ) + print(f"\nGenerated {module_count} module pages + {symbol_count} symbol pages in {version}/reference/python-sdk/") if __name__ == "__main__": diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py index 5a7b32ff67..e039cbc98a 100644 --- a/apps/agentstack-sdk-py/docs/introspect_exports.py +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -16,6 +16,10 @@ import griffe + +SRC_ROOT = Path() + + class ExportItem(BaseModel): model_config = ConfigDict(validate_assignment=True) name: str @@ -45,9 +49,7 @@ def parse_allnames(tree: ast.Module) -> list[str]: and isinstance(node.value, ast.List) ): return [ - elt.value - for elt in node.value.elts - if isinstance(elt, ast.Constant) and isinstance(elt.value, str) + elt.value for elt in node.value.elts if isinstance(elt, ast.Constant) and isinstance(elt.value, str) ] return [] @@ -194,8 +196,7 @@ def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportI if node.names[0].name == "*": if resolved is None: print( - f" ⚠ Cannot resolve relative import " - f"{'.' * node.level}{node.module or ''} in {parse_file}", + f" ⚠ Cannot resolve relative import {'.' * node.level}{node.module or ''} in {parse_file}", file=sys.stderr, ) continue @@ -325,6 +326,7 @@ def _fmt_docstring(ds: griffe.Docstring | None) -> str | None: FILTER_FUNCTION_LABELS = {"module-attribute"} + def _serialize_function(fn: griffe.Function) -> dict[str, Any]: params = [] for p in fn.parameters: @@ -333,7 +335,7 @@ def _serialize_function(fn: griffe.Function) -> dict[str, Any]: entry: dict[str, Any] = {"name": p.name} if p.annotation: entry["type"] = _fmt_annotation(p.annotation) - if p.default is not None and str(p.default) not in ("None", "PosOnlyArgsSep", "KwOnlyArgsSep"): + if p.default is not None and str(p.default) not in ("PosOnlyArgsSep", "KwOnlyArgsSep"): entry["default"] = str(p.default) entry["kind"] = p.kind.value if p.kind and hasattr(p.kind, "value") else str(p.kind) params.append(entry) @@ -433,9 +435,10 @@ def _serialize_class(cls: griffe.Class) -> dict[str, Any]: field["docstring"] = field_doc val = getattr(actual, "value", None) if val is not None: - v = str(val) - if len(v) <= 120: - field["default"] = v + v = str(val)[:120] + field["default"] = v + if len(v) > 120: + field["default"] += "..." class_attrs.append(field) if class_attrs: result["class_attributes"] = class_attrs @@ -476,7 +479,7 @@ def _serialize_class(cls: griffe.Class) -> dict[str, Any]: pe["type"] = _fmt_annotation(p.annotation) if p.default is not None and str(p.default) not in ("None", "PosOnlyArgsSep", "KwOnlyArgsSep"): d = str(p.default) - pe["default"] = d if len(d) <= 80 else "..." + pe["default"] = d if len(d) <= 80 else d[:80] + "..." params.append(pe) if params: method_info["params"] = params @@ -496,23 +499,22 @@ def _serialize_class(cls: griffe.Class) -> dict[str, Any]: def _is_constant(name: str) -> bool: """Check if a name follows the UPPER_SNAKE_CASE constant convention.""" - return bool(re.match(r'^[A-Z0-9_]+$', name)) + return bool(re.match(r"^[A-Z0-9_]+$", name)) def _is_callable_annotation(ann_str: str | None) -> bool: """Return True if the annotation string represents a Callable type.""" if not ann_str: return False - return bool(re.match(r'^(typing\.)?Callable\b', ann_str)) + return bool(re.match(r"^(typing\.)?Callable\b", ann_str)) -import enum class TypingKind(str, enum.Enum): SPECIAL_FORM = "special_form" TYPE_VAR = "type_var" NEW_TYPE = "new_type" - TYPE_ALIAS = "type_alias" # PEP 613 / PEP 695 explicit alias - UNION_ALIAS = "union_alias" # A | B style + TYPE_ALIAS = "type_alias" # PEP 613 / PEP 695 explicit alias + UNION_ALIAS = "union_alias" # A | B style _SPECIAL_FORM_PREFIXES = [ @@ -529,9 +531,9 @@ class TypingKind(str, enum.Enum): *(("typing." + p, TypingKind.SPECIAL_FORM) for p in _SPECIAL_FORM_PREFIXES), *((p, TypingKind.SPECIAL_FORM) for p in _SPECIAL_FORM_PREFIXES), ("typing.TypeVar(", TypingKind.TYPE_VAR), - ("TypeVar(", TypingKind.TYPE_VAR), + ("TypeVar(", TypingKind.TYPE_VAR), ("typing.NewType(", TypingKind.NEW_TYPE), - ("NewType(", TypingKind.NEW_TYPE), + ("NewType(", TypingKind.NEW_TYPE), ] _TYPE_ALIAS_ANNOTATION_NAMES = {"TypeAlias", "typing.TypeAlias", "typing_extensions.TypeAlias"} @@ -564,52 +566,49 @@ def _get_typing_kind(attr: griffe.Attribute) -> str | None: return None -def _serialize_attribute(attr: griffe.Attribute, name: str = "") -> dict[str, Any]: +def _serialize_attribute(attr: griffe.Attribute, name: str = "") -> dict[str, str | list[str] | None]: """ Serialize a module-level attribute/variable or constant. Callable-annotated attributes are serialised with kind="function". - Type alias assignments (typing.Literal, Union, TypeVar, etc.) are + Type alias assignments (typing.Literal, Union, etc.) are serialised with kind="type_alias" and the actual type expression as "type". Other attributes are distinguished as constants (UPPER_SNAKE_CASE) or regular variables. """ ann = getattr(attr, "annotation", None) ann_str = _fmt_annotation(ann) - - if _is_callable_annotation(ann_str): - result: dict[str, Any] = {"kind": "function", "annotation": ann_str} - doc = _fmt_docstring(attr.docstring) - if doc: - result["docstring"] = doc - if attr.labels: - result["labels"] = sorted(str(l) for l in attr.labels if str(l) not in FILTER_FUNCTION_LABELS) - return result + result: dict[str, str | list[str] | None] = {} + doc = _fmt_docstring(attr.docstring) + if doc: + result["docstring"] = doc if typing_kind := _get_typing_kind(attr): val = getattr(attr, "value", None) type_str = str(val).strip() if val is not None else ann_str - result = {"kind": typing_kind} + result["kind"] = typing_kind if type_str: result["definition"] = type_str - doc = _fmt_docstring(attr.docstring) - if doc: - result["docstring"] = doc + return result - kind = "constant" if _is_constant(name) else "attribute" - result: dict[str, Any] = {"kind": kind} - ann = getattr(attr, "annotation", None) if ann: - result["annotation"] = _fmt_annotation(ann) + result["annotation"] = ann_str + + if _is_callable_annotation(ann_str): + result["kind"] = "function" + if attr.labels: + result["labels"] = sorted(str(l) for l in attr.labels if str(l) not in FILTER_FUNCTION_LABELS) + return result + + kind = "constant" if _is_constant(name) else "attribute" + result["kind"] = kind val = getattr(attr, "value", None) if val is not None: v = str(val) if len(v) <= 200: result["value"] = v - doc = _fmt_docstring(attr.docstring) - if doc: - result["docstring"] = doc + return result @@ -627,27 +626,34 @@ def _lookup_griffe(pkg: griffe.Module, dotted_path: str, name: str) -> griffe.Ob return None -_LOGGER_TYPE_NAMES = {"logging.Logger", "Logger", "logging.RootLogger", "RootLogger", "TypeVar", "typing.TypeVar"} +_UNWANTED_ANNOTATIONS = { + "logging.Logger", + "Logger", + "logging.RootLogger", + "RootLogger", + "TypeVar", + "typing.TypeVar", +} + +_UNWANTED_VALUE_PREFIXES = { + "logging.getLogger", + "getLogger", + "TypeVar", + "typing.TypeVar", +} def _is_unwanted_attribute(attr: griffe.Attribute) -> bool: - """Return True if the attribute is a logging.Logger instance.""" + """Return True if the attribute is a logging.Logger instance or TypeVar.""" ann = getattr(attr, "annotation", None) - ann_str = _fmt_annotation(ann) - if ann_str and ann_str in _LOGGER_TYPE_NAMES: + if _fmt_annotation(ann) in _UNWANTED_ANNOTATIONS: return True - # Fallback: check the value expression (e.g. `logging.getLogger(...)`) - type_filter = { - "logging.getLogger", - "getLogger", - "TypeVar", - "typing.TypeVar", - } + val = getattr(attr, "value", None) if val is not None: val_str = str(val).strip() - if any(val_str.startswith(f"{prefix}(") for prefix in type_filter): - return True + return any(val_str.startswith(f"{prefix}(") for prefix in _UNWANTED_VALUE_PREFIXES) + return False @@ -688,7 +694,9 @@ def enrich_api( elif kind == "ATTRIBUTE": if _is_unwanted_attribute(member): # pyrefly: ignore[bad-argument-type] continue - exp = exp.model_copy(update=_serialize_attribute(member, exp.name)) # pyrefly: ignore[bad-argument-type] + exp = exp.model_copy( + update=_serialize_attribute(member, exp.name) + ) # pyrefly: ignore[bad-argument-type] else: exp.kind = kind.lower() doc = _fmt_docstring(getattr(member, "docstring", None)) @@ -701,9 +709,6 @@ def enrich_api( return result -SRC_ROOT = "" - - def main() -> None: parser = argparse.ArgumentParser(description="Introspect agentstack-sdk-py exports and emit a JSON manifest.") parser.add_argument( @@ -721,9 +726,9 @@ def main() -> None: args = parser.parse_args() # Allow helper functions (resolve_absolute, _path_to_module) to use the - # correct source root when --src-root is overridden. + # correct source root when --src-root is overridden. global SRC_ROOT - SRC_ROOT = args.src_root.resolve() + SRC_ROOT = Path(args.src_root.resolve()) if not SRC_ROOT.exists(): sys.exit(f"Package source not found at {SRC_ROOT}") @@ -745,4 +750,4 @@ def main() -> None: if __name__ == "__main__": - main() \ No newline at end of file + main() diff --git a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 index f6d7a90560..1d4c14244a 100644 --- a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 +++ b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 @@ -4,8 +4,13 @@ description: "{{ description }}" --- {{ autogen_warning }} +{%- if base_href and breadcrumb_ancestors %} + +[Python SDK Reference]({{ base_href }}/overview){% for anc_title, anc_filename in breadcrumb_ancestors %} / [{{ anc_title }}]({{ base_href }}/{{ anc_filename }}){% endfor %} / {{ title }} +{%- endif %} {%- if import_example %} + ```py {{ import_example }} ``` diff --git a/apps/agentstack-sdk-py/src/agentstack_sdk/a2a/extensions/tools/exceptions.py b/apps/agentstack-sdk-py/src/agentstack_sdk/a2a/extensions/tools/exceptions.py index 957c46ae9a..5518e83c6a 100644 --- a/apps/agentstack-sdk-py/src/agentstack_sdk/a2a/extensions/tools/exceptions.py +++ b/apps/agentstack-sdk-py/src/agentstack_sdk/a2a/extensions/tools/exceptions.py @@ -4,5 +4,6 @@ from __future__ import annotations + class ToolCallRejectionError(RuntimeError): pass diff --git a/apps/agentstack-sdk-py/src/agentstack_sdk/util/pydantic.py b/apps/agentstack-sdk-py/src/agentstack_sdk/util/pydantic.py index b5f4ce5946..584646413f 100644 --- a/apps/agentstack-sdk-py/src/agentstack_sdk/util/pydantic.py +++ b/apps/agentstack-sdk-py/src/agentstack_sdk/util/pydantic.py @@ -85,10 +85,12 @@ def apply_compatibility_monkey_patching(): # Fix for Python 3.14 + Pydantic 2.12.x + prefer_fwd_module TypeError if sys.version_info >= (3, 14): import typing + with suppress(ImportError, AttributeError): import pydantic._internal._typing_extra as typing_extra if hasattr(typing_extra, "_eval_type"): + def patched_eval_type(value, globalns=None, localns=None, type_params=None): # Python 3.14 typing._eval_type doesn't support prefer_fwd_module # but Pydantic 2.12.x incorrectly passes it. @@ -110,12 +112,15 @@ def patched_eval_type(value, globalns=None, localns=None, type_params=None): try: chat_module._ChatModelKwargsAdapter.validate_python({}) except Exception: + class _ChatModelKwargsRebuilder(BaseModel): kwargs: chat_module.ChatModelKwargs _ChatModelKwargsRebuilder.model_rebuild() # Re-create the adapter with explicit module to ensure forward references are resolved - chat_module._ChatModelKwargsAdapter = TypeAdapter(chat_module.ChatModelKwargs, module=chat_module.__name__) + chat_module._ChatModelKwargsAdapter = TypeAdapter( + chat_module.ChatModelKwargs, module=chat_module.__name__ + ) # Fix EmbeddingModelKwargs with suppress(ImportError, AttributeError): @@ -124,6 +129,7 @@ class _ChatModelKwargsRebuilder(BaseModel): try: embedding_module._EmbeddingModelKwargsAdapter.validate_python({}) except Exception: + class _EmbeddingModelKwargsRebuilder(BaseModel): kwargs: embedding_module.EmbeddingModelKwargs diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx index f9de11f548..11e86712ad 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage.mdx @@ -10,6 +10,8 @@ description: "Storage backends for OAuth flow state" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / OAuth Storage + ```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorage, MemoryTokenStorageFactory, TokenStorageFactory ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx index e02629d32b..ad80f461ad 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorage.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorage +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorage ```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorage ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx index d837b5a1fc..682c38c784 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorageFactory +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / MemoryTokenStorageFactory ```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorageFactory ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx index 4647ef24f8..1ae6c6d358 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/TokenStorageFactory.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / TokenStorageFactory +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Storage](/development/reference/python-sdk/a2a-auth-oauth-storage) / TokenStorageFactory ```py from agentstack_sdk.a2a.extensions.auth.oauth.storage import TokenStorageFactory ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth.mdx index c7d9144a1e..3e3dcd989c 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth.mdx @@ -10,6 +10,8 @@ description: "OAuth 2.0 flow extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / OAuth Extensions + ```py from agentstack_sdk.a2a.extensions.auth.oauth import AuthRequest, AuthResponse, OAuthDemand # ... ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx index 34e449a6c8..3f1df88d50 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthRequest.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthRequest +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthRequest ```py from agentstack_sdk.a2a.extensions.auth.oauth import AuthRequest ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx index 4875c19446..45286896ba 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/AuthResponse.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthResponse +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / AuthResponse ```py from agentstack_sdk.a2a.extensions.auth.oauth import AuthResponse ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx index 4ba54d763e..7c2dc12fe0 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthDemand.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthDemand +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthDemand ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthDemand ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx index f4541ad57b..76f396763f 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionClient.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionClient +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionClient ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionClient ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx index ac2fe7d8f6..3a78503869 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionMetadata.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionMetadata +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionMetadata ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionMetadata ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx index 4e110f46fc..ce7d01cdd3 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionParams.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionParams +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionParams ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionParams ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx index c7b66c7674..da1a7d3319 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionServer +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionServer ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionServer ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx index 5040532eeb..9daeeccb8c 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionSpec.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionSpec +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthExtensionSpec ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionSpec ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx index 704e796a20..de0b97f538 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthFulfillment.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthFulfillment +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [OAuth Extensions](/development/reference/python-sdk/a2a-auth-oauth) / OAuthFulfillment ```py from agentstack_sdk.a2a.extensions.auth.oauth import OAuthFulfillment ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets.mdx index 5703965cec..811563e529 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets.mdx @@ -10,6 +10,8 @@ description: "Secrets injection extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / Secrets Extensions + ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretDemand, SecretFulfillment, SecretsExtensionClient # ... ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx index 9dea273ed4..14e3a547fb 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretDemand.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretDemand +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretDemand ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretDemand ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx index 2b636edc3a..2a2be2dc1b 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretFulfillment.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretFulfillment +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretFulfillment ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretFulfillment ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx index 113317f514..e3c8522f28 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionClient.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionClient +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionClient ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionClient ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx index 90aa99174c..fddaed218b 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionServer.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionServer +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionServer ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionServer ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx index d28c7fe085..e66319ae0f 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionSpec +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsExtensionSpec ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionSpec ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx index aa57f521e4..f23e2930bd 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionMetadata.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionMetadata +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionMetadata ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsServiceExtensionMetadata ``` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx index e829ed2b97..1718beb050 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsServiceExtensionParams.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionParams +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / [Auth Extensions Overview](/development/reference/python-sdk/a2a-auth) / [Secrets Extensions](/development/reference/python-sdk/a2a-auth-secrets) / SecretsServiceExtensionParams ```py from agentstack_sdk.a2a.extensions.auth.secrets import SecretsServiceExtensionParams ``` diff --git a/docs/development/reference/python-sdk/a2a-auth.mdx b/docs/development/reference/python-sdk/a2a-auth.mdx index 5bd0bd773f..fc5647723a 100644 --- a/docs/development/reference/python-sdk/a2a-auth.mdx +++ b/docs/development/reference/python-sdk/a2a-auth.mdx @@ -1,5 +1,5 @@ --- -title: "Auth Extensions" +title: "Auth Extensions Overview" description: "OAuth and secrets authentication extensions" --- @@ -10,6 +10,7 @@ description: "OAuth and secrets authentication extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / Auth Extensions Overview OAuth 2.0 flow extensions diff --git a/docs/development/reference/python-sdk/a2a-common.mdx b/docs/development/reference/python-sdk/a2a-common.mdx index 2b149ace3e..2658ad201b 100644 --- a/docs/development/reference/python-sdk/a2a-common.mdx +++ b/docs/development/reference/python-sdk/a2a-common.mdx @@ -10,6 +10,8 @@ description: "Shared base classes and form types for extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / Common Types + ```py from agentstack_sdk.a2a.extensions.common import BaseField, BaseFormRender, BaseFormResponse # ... ``` diff --git a/docs/development/reference/python-sdk/a2a-interactions.mdx b/docs/development/reference/python-sdk/a2a-interactions.mdx index ebdf24b910..ee7b124018 100644 --- a/docs/development/reference/python-sdk/a2a-interactions.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions.mdx @@ -10,6 +10,8 @@ description: "Human-in-the-loop interaction extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / Interaction Extensions + ```py from agentstack_sdk.a2a.extensions.interactions import ApprovalExtensionClient, ApprovalExtensionMetadata, ApprovalExtensionParams # ... ``` diff --git a/docs/development/reference/python-sdk/a2a-services.mdx b/docs/development/reference/python-sdk/a2a-services.mdx index da5bf3db72..bd2687588d 100644 --- a/docs/development/reference/python-sdk/a2a-services.mdx +++ b/docs/development/reference/python-sdk/a2a-services.mdx @@ -10,6 +10,8 @@ description: "LLM, embedding, MCP, and platform service extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / Service Extensions + ```py from agentstack_sdk.a2a.extensions.services import EmbeddingDemand, EmbeddingFulfillment, EmbeddingServiceExtensionClient # ... ``` diff --git a/docs/development/reference/python-sdk/a2a-tools.mdx b/docs/development/reference/python-sdk/a2a-tools.mdx index a028216f62..5427cbe178 100644 --- a/docs/development/reference/python-sdk/a2a-tools.mdx +++ b/docs/development/reference/python-sdk/a2a-tools.mdx @@ -10,6 +10,8 @@ description: "Tool call approval extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / Tool Extensions + ```py from agentstack_sdk.a2a.extensions.tools import ToolCallExtensionClient, ToolCallExtensionMetadata, ToolCallExtensionParams # ... ``` diff --git a/docs/development/reference/python-sdk/a2a-ui.mdx b/docs/development/reference/python-sdk/a2a-ui.mdx index 48f88048cb..4352d6b298 100644 --- a/docs/development/reference/python-sdk/a2a-ui.mdx +++ b/docs/development/reference/python-sdk/a2a-ui.mdx @@ -10,6 +10,8 @@ description: "Rich UI component extensions" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / UI Extensions + ```py from agentstack_sdk.a2a.extensions.ui import AgentDetail, AgentDetailContributor, AgentDetailExtensionClient # ... ``` diff --git a/docs/development/reference/python-sdk/platform-common.mdx b/docs/development/reference/python-sdk/platform-common.mdx index 70179fd1e0..503c83ae42 100644 --- a/docs/development/reference/python-sdk/platform-common.mdx +++ b/docs/development/reference/python-sdk/platform-common.mdx @@ -10,6 +10,8 @@ description: "Shared types and utilities" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / Common + ```py from agentstack_sdk.platform.common import GithubVersionType, PaginatedResult, ResolvedDockerImageID # ... ``` diff --git a/docs/development/reference/python-sdk/platform-context.mdx b/docs/development/reference/python-sdk/platform-context.mdx index 856aa65f42..a07a09f018 100644 --- a/docs/development/reference/python-sdk/platform-context.mdx +++ b/docs/development/reference/python-sdk/platform-context.mdx @@ -10,6 +10,8 @@ description: "Context management" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / Context + ```py from agentstack_sdk.platform.context import Context, ContextHistoryItem, ContextPermissions # ... ``` diff --git a/docs/development/reference/python-sdk/platform.mdx b/docs/development/reference/python-sdk/platform.mdx index 472f829bc5..48633c66c7 100644 --- a/docs/development/reference/python-sdk/platform.mdx +++ b/docs/development/reference/python-sdk/platform.mdx @@ -10,6 +10,8 @@ description: "Clients for files, vector stores, contexts, providers, and more" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / Platform + ```py from agentstack_sdk.platform import PlatformClient, SystemConfiguration, AuthorizationCodeRequest # ... ``` diff --git a/docs/development/reference/python-sdk/platform/AddProvider.mdx b/docs/development/reference/python-sdk/platform/AddProvider.mdx index 36b17ed80a..50f3e03a44 100644 --- a/docs/development/reference/python-sdk/platform/AddProvider.mdx +++ b/docs/development/reference/python-sdk/platform/AddProvider.mdx @@ -21,5 +21,5 @@ from agentstack_sdk.platform import AddProvider | Attribute | Type | Default | |-------|------|---------| | `type` | `Literal['add_provider']` | `'add_provider'` | -| `auto_stop_timeout_sec` | `int \| None` | — | +| `auto_stop_timeout_sec` | `int \| None` | `pydantic.Field(default=None, gt=0, le=60...` | | `variables` | `dict[str, str] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx index 46f33733e5..6a8b56c804 100644 --- a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx +++ b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx @@ -19,4 +19,4 @@ from agentstack_sdk.platform import BuildConfiguration | Attribute | Type | Default | |-------|------|---------| -| `dockerfile_path` | `Path \| None` | — | +| `dockerfile_path` | `Path \| None` | `Field(default=None, description='Path to...` | diff --git a/docs/development/reference/python-sdk/server-middleware-platform-auth-backend.mdx b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend.mdx new file mode 100644 index 0000000000..99ea870a9a --- /dev/null +++ b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend.mdx @@ -0,0 +1,32 @@ +--- +title: "Server Middleware Platform Auth Backend" +description: "Core server for creating and running A2A-compatible agents" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Server Middleware Platform Auth Backend + +```py +from agentstack_sdk.server.middleware.platform_auth_backend import PlatformAuthBackend, PlatformAuthenticatedUser, discover_jwks +``` +--- +### Classes + + + + + + + +### Functions + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx new file mode 100644 index 0000000000..fc6fb9a7f5 --- /dev/null +++ b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx @@ -0,0 +1,61 @@ +--- +title: "PlatformAuthBackend" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Middleware Platform Auth Backend](/development/reference/python-sdk/server-middleware-platform-auth-backend) / PlatformAuthBackend +```py +from agentstack_sdk.server.middleware.platform_auth_backend import PlatformAuthBackend +``` +**Bases:** `SdkAuthenticationBackend` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `skip_audience_validation` | `bool` | `skip_audience_validation if skip_audienc...` | +| `security` | `HTTPBearer` | `HTTPBearer(auto_error=False)` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `public_url` | `str \| None` | — | +| `skip_audience_validation` | `bool \| None` | — | + +**Returns:** `None` + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `conn` | `HTTPConnection` | — | + +**Returns:** `tuple[AuthCredentials, BaseUser] | None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `agent_card` | `AgentCard` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthenticatedUser.mdx b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthenticatedUser.mdx new file mode 100644 index 0000000000..d2f53dae25 --- /dev/null +++ b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthenticatedUser.mdx @@ -0,0 +1,42 @@ +--- +title: "PlatformAuthenticatedUser" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Middleware Platform Auth Backend](/development/reference/python-sdk/server-middleware-platform-auth-backend) / PlatformAuthenticatedUser +```py +from agentstack_sdk.server.middleware.platform_auth_backend import PlatformAuthenticatedUser +``` +**Bases:** `User , BaseUser` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `claims` | `dict[str, JsonValue]` | `claims` | +| `auth_token` | `Secret[str]` | `Secret(auth_token)` | +| `is_authenticated` | `bool` | — | +| `user_name` | `str` | — | +| `display_name` | `str` | — | +| `identity` | `str` | — | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `claims` | `dict[str, JsonValue]` | — | +| `auth_token` | `str` | — | + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/discover_jwks.mdx b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/discover_jwks.mdx new file mode 100644 index 0000000000..b69853af31 --- /dev/null +++ b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/discover_jwks.mdx @@ -0,0 +1,21 @@ +--- +title: "discover_jwks" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Middleware Platform Auth Backend](/development/reference/python-sdk/server-middleware-platform-auth-backend) / discover_jwks +```py +from agentstack_sdk.server.middleware.platform_auth_backend import discover_jwks +``` +Labels: `async` +## Returns + +`KeySet` + diff --git a/docs/development/reference/python-sdk/server-store-memory-context-store.mdx b/docs/development/reference/python-sdk/server-store-memory-context-store.mdx new file mode 100644 index 0000000000..18c4db5f7e --- /dev/null +++ b/docs/development/reference/python-sdk/server-store-memory-context-store.mdx @@ -0,0 +1,26 @@ +--- +title: "Server Memory Context Store" +description: "In-memory context store for the server" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Server Memory Context Store + +```py +from agentstack_sdk.server.store.memory_context_store import InMemoryContextStore, MemoryContextStoreInstance +``` +--- +### Classes + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-store-memory-context-store/InMemoryContextStore.mdx b/docs/development/reference/python-sdk/server-store-memory-context-store/InMemoryContextStore.mdx new file mode 100644 index 0000000000..a2473fc252 --- /dev/null +++ b/docs/development/reference/python-sdk/server-store-memory-context-store/InMemoryContextStore.mdx @@ -0,0 +1,47 @@ +--- +title: "InMemoryContextStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Memory Context Store](/development/reference/python-sdk/server-store-memory-context-store) / InMemoryContextStore +```py +from agentstack_sdk.server.store.memory_context_store import InMemoryContextStore +``` +**Bases:** `ContextStore` +## Methods + + + + +Initialize in-memory context store with TTL cache. + +Args: + max_contexts: Maximum number of contexts to keep in memory + ttl_seconds: Time-to-live for context instances in seconds (default: 1 hour) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `max_contexts` | `int` | `1000` | +| `context_ttl` | `timedelta` | `timedelta(hours=1)` | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `initialized_dependencies` | `list[Dependency]` | — | + +**Returns:** `ContextStoreInstance` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-store-memory-context-store/MemoryContextStoreInstance.mdx b/docs/development/reference/python-sdk/server-store-memory-context-store/MemoryContextStoreInstance.mdx new file mode 100644 index 0000000000..bbdfe80502 --- /dev/null +++ b/docs/development/reference/python-sdk/server-store-memory-context-store/MemoryContextStoreInstance.mdx @@ -0,0 +1,66 @@ +--- +title: "MemoryContextStoreInstance" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Memory Context Store](/development/reference/python-sdk/server-store-memory-context-store) / MemoryContextStoreInstance +```py +from agentstack_sdk.server.store.memory_context_store import MemoryContextStoreInstance +``` +**Bases:** `ContextStoreInstance` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context_id` | — | `context_id` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `load_history_items` | `bool` | `False` | + +**Returns:** `AsyncIterator[ContextHistoryItem | Message | Artifact]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-store-platform-context-store.mdx b/docs/development/reference/python-sdk/server-store-platform-context-store.mdx new file mode 100644 index 0000000000..c5eebbd1c7 --- /dev/null +++ b/docs/development/reference/python-sdk/server-store-platform-context-store.mdx @@ -0,0 +1,26 @@ +--- +title: "Server Platform Context Store" +description: "Platform context store for the server" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / Server Platform Context Store + +```py +from agentstack_sdk.server.store.platform_context_store import PlatformContextStore, PlatformContextStoreInstance +``` +--- +### Classes + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStore.mdx b/docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStore.mdx new file mode 100644 index 0000000000..bf27c9eb7f --- /dev/null +++ b/docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStore.mdx @@ -0,0 +1,44 @@ +--- +title: "PlatformContextStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Platform Context Store](/development/reference/python-sdk/server-store-platform-context-store) / PlatformContextStore +```py +from agentstack_sdk.server.store.platform_context_store import PlatformContextStore +``` +**Bases:** `ContextStore` +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `dependencies` | `dict[str, Depends]` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `initialized_dependencies` | `list[Dependency]` | — | + +**Returns:** `ContextStoreInstance` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStoreInstance.mdx b/docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStoreInstance.mdx new file mode 100644 index 0000000000..77e512c3b9 --- /dev/null +++ b/docs/development/reference/python-sdk/server-store-platform-context-store/PlatformContextStoreInstance.mdx @@ -0,0 +1,61 @@ +--- +title: "PlatformContextStoreInstance" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Server](/development/reference/python-sdk/server) / [Server Platform Context Store](/development/reference/python-sdk/server-store-platform-context-store) / PlatformContextStoreInstance +```py +from agentstack_sdk.server.store.platform_context_store import PlatformContextStoreInstance +``` +**Bases:** `ContextStoreInstance` +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str` | — | +| `platform_extension` | `PlatformApiExtensionServer` | — | + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `load_history_items` | `bool` | `False` | + +**Returns:** `AsyncIterator[ContextHistoryItem | Message | Artifact]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `data` | `Message \| Artifact` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `from_id` | `UUID` | — | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/server.mdx b/docs/development/reference/python-sdk/server.mdx index 65df8e59ae..efe8027705 100644 --- a/docs/development/reference/python-sdk/server.mdx +++ b/docs/development/reference/python-sdk/server.mdx @@ -10,9 +10,21 @@ description: "Core server for creating and running A2A-compatible agents" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} + ```py from agentstack_sdk.server import Server ``` + + + Platform authentication middleware + + + Context management using in-memory storage + + + Context management using platform storage + + --- ### Classes diff --git a/docs/development/reference/python-sdk/server/Agent.mdx b/docs/development/reference/python-sdk/server/Agent.mdx index 6983d327ba..282c491d02 100644 --- a/docs/development/reference/python-sdk/server/Agent.mdx +++ b/docs/development/reference/python-sdk/server/Agent.mdx @@ -45,23 +45,23 @@ Create an Agent function. | Name | Type | Default | |------|------|---------| -| `name` | `str \| None` | — | -| `description` | `str \| None` | — | +| `name` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | | `url` | `str` | `'http://invalid'` | -| `additional_interfaces` | `list[AgentInterface] \| None` | — | -| `capabilities` | `AgentCapabilities \| None` | — | -| `default_input_modes` | `list[str] \| None` | — | -| `default_output_modes` | `list[str] \| None` | — | -| `detail` | `AgentDetail \| None` | — | -| `documentation_url` | `str \| None` | — | -| `icon_url` | `str \| None` | — | -| `preferred_transport` | `str \| None` | — | -| `provider` | `AgentProvider \| None` | — | -| `security` | `list[dict[str, list[str]]] \| None` | — | -| `security_schemes` | `dict[str, SecurityScheme] \| None` | — | -| `skills` | `list[AgentSkill] \| None` | — | -| `supports_authenticated_extended_card` | `bool \| None` | — | -| `version` | `str \| None` | — | +| `additional_interfaces` | `list[AgentInterface] \| None` | `None` | +| `capabilities` | `AgentCapabilities \| None` | `None` | +| `default_input_modes` | `list[str] \| None` | `None` | +| `default_output_modes` | `list[str] \| None` | `None` | +| `detail` | `AgentDetail \| None` | `None` | +| `documentation_url` | `str \| None` | `None` | +| `icon_url` | `str \| None` | `None` | +| `preferred_transport` | `str \| None` | `None` | +| `provider` | `AgentProvider \| None` | `None` | +| `security` | `list[dict[str, list[str]]] \| None` | `None` | +| `security_schemes` | `dict[str, SecurityScheme] \| None` | `None` | +| `skills` | `list[AgentSkill] \| None` | `None` | +| `supports_authenticated_extended_card` | `bool \| None` | `None` | +| `version` | `str \| None` | `None` | ## Returns diff --git a/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx b/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx index 62895c3724..ef88306638 100644 --- a/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx +++ b/docs/development/reference/python-sdk/server/PlatformAuthBackend.mdx @@ -19,7 +19,7 @@ from agentstack_sdk.server import PlatformAuthBackend | Attribute | Type | Default | |-------|------|---------| -| `skip_audience_validation` | `bool` | — | +| `skip_audience_validation` | `bool` | `skip_audience_validation if skip_audienc...` | | `security` | `HTTPBearer` | `HTTPBearer(auto_error=False)` | ## Methods diff --git a/docs/development/reference/python-sdk/server/create_app.mdx b/docs/development/reference/python-sdk/server/create_app.mdx index 0a7c4edea6..96e43f8d5c 100644 --- a/docs/development/reference/python-sdk/server/create_app.mdx +++ b/docs/development/reference/python-sdk/server/create_app.mdx @@ -19,14 +19,14 @@ from agentstack_sdk.server import create_app | Name | Type | Default | |------|------|---------| | `agent` | `Agent` | — | -| `task_store` | `TaskStore \| None` | — | -| `context_store` | `ContextStore \| None` | — | -| `queue_manager` | `QueueManager \| None` | — | -| `push_config_store` | `PushNotificationConfigStore \| None` | — | -| `push_sender` | `PushNotificationSender \| None` | — | -| `request_context_builder` | `RequestContextBuilder \| None` | — | -| `lifespan` | `Lifespan[AppType] \| None` | — | -| `dependencies` | `list[Depends] \| None` | — | +| `task_store` | `TaskStore \| None` | `None` | +| `context_store` | `ContextStore \| None` | `None` | +| `queue_manager` | `QueueManager \| None` | `None` | +| `push_config_store` | `PushNotificationConfigStore \| None` | `None` | +| `push_sender` | `PushNotificationSender \| None` | `None` | +| `request_context_builder` | `RequestContextBuilder \| None` | `None` | +| `lifespan` | `Lifespan[AppType] \| None` | `None` | +| `dependencies` | `list[Depends] \| None` | `None` | | `override_interfaces` | `bool` | `True` | | `task_timeout` | `timedelta` | `timedelta(minutes=10)` | | `kwargs` | — | `{}` | diff --git a/docs/development/reference/python-sdk/types.mdx b/docs/development/reference/python-sdk/types.mdx index c745b4036d..e2cfeed53d 100644 --- a/docs/development/reference/python-sdk/types.mdx +++ b/docs/development/reference/python-sdk/types.mdx @@ -10,6 +10,7 @@ description: "Core type definitions and base classes" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} + ```py from agentstack_sdk.types import SdkAuthenticationBackend ``` diff --git a/docs/development/reference/python-sdk/util.mdx b/docs/development/reference/python-sdk/util.mdx index 72c69c82aa..1127061aac 100644 --- a/docs/development/reference/python-sdk/util.mdx +++ b/docs/development/reference/python-sdk/util.mdx @@ -10,6 +10,7 @@ description: "Utility helpers" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} + ```py from agentstack_sdk.util import resource_context ``` diff --git a/docs/development/reference/python-sdk/util/ColoredFormatter.mdx b/docs/development/reference/python-sdk/util/ColoredFormatter.mdx index ec6d0f3c4c..661ff4e5c4 100644 --- a/docs/development/reference/python-sdk/util/ColoredFormatter.mdx +++ b/docs/development/reference/python-sdk/util/ColoredFormatter.mdx @@ -19,7 +19,7 @@ from agentstack_sdk.util import ColoredFormatter | Attribute | Type | Default | |-------|------|---------| -| `COLORS` | `dict[str, str]` | — | +| `COLORS` | `dict[str, str]` | `{'DEBUG': '\x1b[36m', 'INFO': '\x1b[32m'...` | ## Methods diff --git a/docs/development/reference/python-sdk/util/configure_logger.mdx b/docs/development/reference/python-sdk/util/configure_logger.mdx index e408b7fa5a..71894f0a83 100644 --- a/docs/development/reference/python-sdk/util/configure_logger.mdx +++ b/docs/development/reference/python-sdk/util/configure_logger.mdx @@ -18,7 +18,7 @@ from agentstack_sdk.util import configure_logger | Name | Type | Default | |------|------|---------| -| `level` | `int \| str \| None` | — | +| `level` | `int \| str \| None` | `None` | ## Returns diff --git a/docs/development/reference/python-sdk/util/flatten_dict.mdx b/docs/development/reference/python-sdk/util/flatten_dict.mdx index c388a5fd78..8c381f257f 100644 --- a/docs/development/reference/python-sdk/util/flatten_dict.mdx +++ b/docs/development/reference/python-sdk/util/flatten_dict.mdx @@ -26,7 +26,7 @@ Flatten nested dict → OpenTelemetry-compatible flat dict. | `parent_key` | `str` | `''` | | `sep` | `str` | `'.'` | | `skip_none` | `bool` | `True` | -| `max_depth` | `int \| None` | — | +| `max_depth` | `int \| None` | `None` | ## Returns diff --git a/docs/development/reference/python-sdk/util/load_file.mdx b/docs/development/reference/python-sdk/util/load_file.mdx index f4b10580e4..4ba1535934 100644 --- a/docs/development/reference/python-sdk/util/load_file.mdx +++ b/docs/development/reference/python-sdk/util/load_file.mdx @@ -23,7 +23,7 @@ Labels: `async` |------|------|---------| | `part` | `FilePart` | — | | `stream` | `bool` | `False` | -| `client` | `AsyncClient \| None` | — | +| `client` | `AsyncClient \| None` | `None` | ## Returns diff --git a/docs/development/reference/python-sdk/util/trace_class.mdx b/docs/development/reference/python-sdk/util/trace_class.mdx index 0c9cb8ceab..e021a21ec9 100644 --- a/docs/development/reference/python-sdk/util/trace_class.mdx +++ b/docs/development/reference/python-sdk/util/trace_class.mdx @@ -66,10 +66,10 @@ Example: | Name | Type | Default | |------|------|---------| -| `include_list` | `list[str] \| None` | — | -| `exclude_list` | `list[str] \| None` | — | +| `include_list` | `list[str] \| None` | `None` | +| `exclude_list` | `list[str] \| None` | `None` | | `kind` | `SpanKind` | `SpanKind.INTERNAL` | -| `attributes` | `dict[str, Any] \| None` | — | +| `attributes` | `dict[str, Any] \| None` | `None` | ## Returns diff --git a/docs/development/reference/python-sdk/util/trace_function.mdx b/docs/development/reference/python-sdk/util/trace_function.mdx index 5a89371bcf..04ca6dac30 100644 --- a/docs/development/reference/python-sdk/util/trace_function.mdx +++ b/docs/development/reference/python-sdk/util/trace_function.mdx @@ -60,11 +60,11 @@ Returns: | Name | Type | Default | |------|------|---------| -| `func` | `Callable \| None` | — | -| `span_name` | `str \| None` | — | +| `func` | `Callable \| None` | `None` | +| `span_name` | `str \| None` | `None` | | `kind` | `SpanKind` | `SpanKind.INTERNAL` | -| `attributes` | `dict[str, Any] \| None` | — | -| `attribute_extractor` | `Callable \| None` | — | +| `attributes` | `dict[str, Any] \| None` | `None` | +| `attribute_extractor` | `Callable \| None` | `None` | ## Returns diff --git a/docs/docs.json b/docs/docs.json index d5284ab801..71b2a9c1cb 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -142,12 +142,7 @@ "group": "Python SDK", "pages": [ "development/reference/python-sdk/overview", - { - "group": "Server", - "pages": [ - "development/reference/python-sdk/server" - ] - }, + "development/reference/python-sdk/server", { "group": "A2A Extensions", "pages": [ From 44fac130bd670978beb4abfdd0e0cf1822a4f455 Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Wed, 4 Mar 2026 11:15:59 +0100 Subject: [PATCH 5/8] v1 Signed-off-by: Jan Jeliga --- CONTRIBUTING.md | 4 +- apps/agentstack-sdk-py/docs/generate_docs.py | 29 +-- .../docs/introspect_exports.py | 1 + .../docs/templates/module.mdx.j2 | 2 + .../reference/python-sdk/a2a-auth.mdx | 2 + docs/development/reference/python-sdk/a2a.mdx | 2 + .../reference/python-sdk/platform-common.mdx | 2 +- .../platform-common/GithubVersionType.mdx | 2 +- .../platform-common/PaginatedResult.mdx | 2 +- .../platform-common/ResolvedDockerImageID.mdx | 2 +- .../platform-common/ResolvedGithubUrl.mdx | 2 +- .../reference/python-sdk/platform-context.mdx | 2 +- .../python-sdk/platform-context/Context.mdx | 2 +- .../platform-context/ContextHistoryItem.mdx | 2 +- .../platform-context/ContextPermissions.mdx | 2 +- .../platform-context/ContextToken.mdx | 2 +- .../platform-context/Permissions.mdx | 2 +- .../reference/python-sdk/platform-new.mdx | 211 ++++++++++++++++ .../python-sdk/platform-new/AddProvider.mdx | 25 ++ .../platform-new/AuthorizationCodeRequest.mdx | 23 ++ .../platform-new/BuildConfiguration.mdx | 22 ++ .../python-sdk/platform-new/BuildState.mdx | 26 ++ .../platform-new/ChangeRoleResponse.mdx | 23 ++ .../python-sdk/platform-new/Connector.mdx | 234 ++++++++++++++++++ .../platform-new/ConnectorPreset.mdx | 23 ++ .../platform-new/ConnectorState.mdx | 25 ++ .../platform-new/DiscoveryState.mdx | 25 ++ .../python-sdk/platform-new/EnvVar.mdx | 24 ++ .../platform-new/ExtractedFileInfo.mdx | 23 ++ .../python-sdk/platform-new/Extraction.mdx | 31 +++ .../python-sdk/platform-new/File.mdx | 164 ++++++++++++ .../platform-new/ListUserFeedbackResponse.mdx | 17 ++ .../platform-new/MCPProxyResponse.mdx | 24 ++ .../platform-new/ModelCapability.mdx | 23 ++ .../python-sdk/platform-new/ModelProvider.mdx | 97 ++++++++ .../platform-new/ModelProviderState.mdx | 23 ++ .../platform-new/ModelProviderType.mdx | 42 ++++ .../platform-new/ModelWithScore.mdx | 23 ++ .../python-sdk/platform-new/NoAction.mdx | 22 ++ .../platform-new/PlatformClient.mdx | 59 +++++ .../python-sdk/platform-new/Provider.mdx | 166 +++++++++++++ .../python-sdk/platform-new/ProviderBuild.mdx | 108 ++++++++ .../platform-new/ProviderDiscovery.mdx | 56 +++++ .../platform-new/ProviderErrorMessage.mdx | 22 ++ .../platform-new/SystemConfiguration.mdx | 57 +++++ .../platform-new/UpdateProvider.mdx | 23 ++ .../python-sdk/platform-new/User.mdx | 67 +++++ .../python-sdk/platform-new/UserFeedback.mdx | 51 ++++ .../python-sdk/platform-new/UserRole.mdx | 24 ++ .../python-sdk/platform-new/Variables.mdx | 51 ++++ .../python-sdk/platform-new/VectorStore.mdx | 120 +++++++++ .../platform-new/VectorStoreDocument.mdx | 26 ++ .../platform-new/VectorStoreItem.mdx | 40 +++ .../platform-new/VectorStoreSearchResult.mdx | 23 ++ .../platform-new/VectorStoreStats.mdx | 23 ++ .../python-sdk/platform-new/VersionInfo.mdx | 23 ++ .../platform-new/get_platform_client.mdx | 16 ++ .../platform-new/set_platform_client.mdx | 16 ++ .../platform-new/use_platform_client.mdx | 16 ++ .../python-sdk/platform-new/uuid_to_str.mdx | 27 ++ .../platform-new/validate_metadata.mdx | 26 ++ .../reference/python-sdk/server.mdx | 2 + docs/docs.json | 10 +- 63 files changed, 2226 insertions(+), 38 deletions(-) create mode 100644 docs/development/reference/python-sdk/platform-new.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/AddProvider.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/AuthorizationCodeRequest.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/BuildConfiguration.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/BuildState.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ChangeRoleResponse.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/Connector.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ConnectorPreset.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ConnectorState.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/DiscoveryState.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/EnvVar.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ExtractedFileInfo.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/Extraction.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/File.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ListUserFeedbackResponse.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/MCPProxyResponse.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ModelCapability.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ModelProvider.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ModelProviderState.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ModelProviderType.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ModelWithScore.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/NoAction.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/PlatformClient.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/Provider.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ProviderBuild.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ProviderDiscovery.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/ProviderErrorMessage.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/SystemConfiguration.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/UpdateProvider.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/User.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/UserFeedback.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/UserRole.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/Variables.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/VectorStore.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/VectorStoreDocument.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/VectorStoreItem.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/VectorStoreSearchResult.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/VectorStoreStats.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/VersionInfo.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/get_platform_client.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/set_platform_client.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/use_platform_client.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/uuid_to_str.mdx create mode 100644 docs/development/reference/python-sdk/platform-new/validate_metadata.mdx diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50f565e4a2..14f30376c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -345,7 +345,9 @@ There are two documentation folders: `docs/stable` and `docs/development`. Due t All PRs **must** either include corresponding documentation in `docs/development`, or include `[x] No Docs Needed` in the PR description. This is checked by GitHub Actions. -Special care needs to be taken with the `docs/development/reference/cli-reference.mdx` file, which is automatically generated. Use `mise run agentstack-cli:docs` to regenerate this file when modifying the CLI interface. +Special care needs to be taken with the `docs/development/reference/` folder, as its contents are automatically generated. Use `mise run agentstack-cli:docs` to regenerate the CLI reference when modifying the CLI interface. Use `mise run agentstack-sdk-py:docs` to regenerate the Python SDK reference when making any changes to it; Additionally, modify the corresponding SDK reference generating scripts in `apps/agentstack-sdk-py/docs` and the docs/docs.json file whenever you change the package import structure to reflect those changes. + +Tha same applies to files the `docs/development/reference/` Try to follow this structure: diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py index 61752150b0..77cca6638e 100644 --- a/apps/agentstack-sdk-py/docs/generate_docs.py +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -74,7 +74,11 @@ # submodule_cards – optional list of child modules rendered as a card grid # group_by_origin – split items into sections per origin sub-module (used for platform) -# TODO: This must be updated when the imports logic and structure changes, for example if we directly populate some __init__.py file instead of importing directly from some .py file +# This must be updated when the imports logic and structure changes, +# for example if we directly populate some __init__.py file instead of importing directly from some .py file. +# On one hand, this allows fine grained control over what we actually show in the docs, on the other hand it requires maintenance. +# One must also update the docs/docs.json file to add the generated pages to the sidebar. + PAGE_CONFIG: list[dict] = [ # ── server ──────────────────────────────────────────────────────────────── { @@ -216,24 +220,16 @@ "import_path": "agentstack_sdk.a2a.extensions.ui", }, # ── platform (grouped by sub-module) ────────────────────────────────────── - { - "json_key": None, - "filename": "platform-idx", - "title": "Platform API Overview", + { + "json_key": "agentstack_sdk.platform", + "filename": "platform-new", + "title": "Platform", "description": "Clients for files, vector stores, contexts, providers, and more", "import_path": "agentstack_sdk.platform", "submodule_cards": [ - {"title": "Platform", "filename": "platform", "description": "General platform client and utilities"}, {"title": "Common", "filename": "platform-common", "description": "Shared types and utilities"}, {"title": "Context", "filename": "platform-context", "description": "Context management"}, ], - }, - { - "json_key": "agentstack_sdk.platform", - "filename": "platform", - "title": "Platform", - "description": "Clients for files, vector stores, contexts, providers, and more", - "import_path": "agentstack_sdk.platform", "group_by_origin": True, }, # ── platform.context ────────────────────────────────────────────────────── @@ -364,7 +360,7 @@ def _mdx_escape(text: str | None) -> str: _FILENAME_TO_PARENT: dict[str, str] = {} # child filename → parent filename -def _build_module_maps() -> None: +def _build_high_level_import_maps() -> None: if _JSON_KEY_TO_FILENAME: return for cfg in PAGE_CONFIG: @@ -390,7 +386,7 @@ def _symbol_breadcrumb_ancestors(parent_filename: str) -> list[tuple[str, str]]: def _find_longest_matching_json_key(origin: str) -> str | None: - """Return the longest PAGE_CONFIG json_key that is a prefix of *origin*.""" + """Return the longest _JSON_KEY_TO_FILENAME (PAGE_CONFIG) json_key that is a prefix of *origin*.""" best_key: str | None = None best_len = 0 for key in _JSON_KEY_TO_FILENAME: @@ -404,7 +400,6 @@ def _symbol_import_path(item: dict) -> str: """Best import path to use on a symbol's own page.""" origin = item.get("origin", "") longest = _find_longest_matching_json_key(origin) - if longest: return _JSON_KEY_TO_IMPORT_PATH[longest] @@ -594,7 +589,7 @@ def render_function_page( def main() -> None: - _build_module_maps() + _build_high_level_import_maps() parser = argparse.ArgumentParser( description="Generate Python SDK reference docs (MDX) from exports_structure.json." ) diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py index e039cbc98a..aa8af8747d 100644 --- a/apps/agentstack-sdk-py/docs/introspect_exports.py +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -268,6 +268,7 @@ def _init_imports_file(init_file: Path, module_stem: str) -> bool: return False +# TODO: this might need to change if the logic of how the classes etc. are exposed changes def trace_package(root: Path) -> dict[str, list[ExportItem]]: """ Walk every __init__.py in the package and compute its effective public API. diff --git a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 index 1d4c14244a..c32f911950 100644 --- a/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 +++ b/apps/agentstack-sdk-py/docs/templates/module.mdx.j2 @@ -17,6 +17,8 @@ description: "{{ description }}" {%- endif %} {%- if submodule_cards %} +## Submodules + {%- for card in submodule_cards %} diff --git a/docs/development/reference/python-sdk/a2a-auth.mdx b/docs/development/reference/python-sdk/a2a-auth.mdx index fc5647723a..31ae8dad63 100644 --- a/docs/development/reference/python-sdk/a2a-auth.mdx +++ b/docs/development/reference/python-sdk/a2a-auth.mdx @@ -11,6 +11,8 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack */} [Python SDK Reference](/development/reference/python-sdk/overview) / [A2A Extensions](/development/reference/python-sdk/a2a) / Auth Extensions Overview +## Submodules + OAuth 2.0 flow extensions diff --git a/docs/development/reference/python-sdk/a2a.mdx b/docs/development/reference/python-sdk/a2a.mdx index 5047b4e699..b773cd27aa 100644 --- a/docs/development/reference/python-sdk/a2a.mdx +++ b/docs/development/reference/python-sdk/a2a.mdx @@ -10,6 +10,8 @@ description: "Extensions for the A2A protocol — authentication, services, tool DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} +## Submodules + OAuth and secrets authentication diff --git a/docs/development/reference/python-sdk/platform-common.mdx b/docs/development/reference/python-sdk/platform-common.mdx index 503c83ae42..de1a334f2f 100644 --- a/docs/development/reference/python-sdk/platform-common.mdx +++ b/docs/development/reference/python-sdk/platform-common.mdx @@ -10,7 +10,7 @@ description: "Shared types and utilities" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / Common +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Common ```py from agentstack_sdk.platform.common import GithubVersionType, PaginatedResult, ResolvedDockerImageID # ... diff --git a/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx b/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx index 6f84d393fc..ac0b4df857 100644 --- a/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx +++ b/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / GithubVersionType +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / GithubVersionType ```py from agentstack_sdk.platform.common import GithubVersionType ``` diff --git a/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx b/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx index 8fee0395a5..bc2d8080ea 100644 --- a/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx +++ b/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / PaginatedResult +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / PaginatedResult ```py from agentstack_sdk.platform.common import PaginatedResult ``` diff --git a/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx b/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx index d982111169..1e87c0e445 100644 --- a/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx +++ b/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / ResolvedDockerImageID +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / ResolvedDockerImageID ```py from agentstack_sdk.platform.common import ResolvedDockerImageID ``` diff --git a/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx b/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx index 472990b03c..1ff821e9d7 100644 --- a/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx +++ b/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Common](/development/reference/python-sdk/platform-common) / ResolvedGithubUrl +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / ResolvedGithubUrl ```py from agentstack_sdk.platform.common import ResolvedGithubUrl ``` diff --git a/docs/development/reference/python-sdk/platform-context.mdx b/docs/development/reference/python-sdk/platform-context.mdx index a07a09f018..02ba6831d3 100644 --- a/docs/development/reference/python-sdk/platform-context.mdx +++ b/docs/development/reference/python-sdk/platform-context.mdx @@ -10,7 +10,7 @@ description: "Context management" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / Context +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Context ```py from agentstack_sdk.platform.context import Context, ContextHistoryItem, ContextPermissions # ... diff --git a/docs/development/reference/python-sdk/platform-context/Context.mdx b/docs/development/reference/python-sdk/platform-context/Context.mdx index 793cc553f5..634698311f 100644 --- a/docs/development/reference/python-sdk/platform-context/Context.mdx +++ b/docs/development/reference/python-sdk/platform-context/Context.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / Context +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / Context ```py from agentstack_sdk.platform.context import Context ``` diff --git a/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx b/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx index 51256f1437..1463071797 100644 --- a/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / ContextHistoryItem +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / ContextHistoryItem ```py from agentstack_sdk.platform.context import ContextHistoryItem ``` diff --git a/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx b/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx index 26c1b961ed..7eaa60801f 100644 --- a/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / ContextPermissions +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / ContextPermissions ```py from agentstack_sdk.platform.context import ContextPermissions ``` diff --git a/docs/development/reference/python-sdk/platform-context/ContextToken.mdx b/docs/development/reference/python-sdk/platform-context/ContextToken.mdx index 1ea82ca0c5..a4aa9b69dd 100644 --- a/docs/development/reference/python-sdk/platform-context/ContextToken.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextToken.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / ContextToken +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / ContextToken ```py from agentstack_sdk.platform.context import ContextToken ``` diff --git a/docs/development/reference/python-sdk/platform-context/Permissions.mdx b/docs/development/reference/python-sdk/platform-context/Permissions.mdx index b4e2ac4522..62d66a61bb 100644 --- a/docs/development/reference/python-sdk/platform-context/Permissions.mdx +++ b/docs/development/reference/python-sdk/platform-context/Permissions.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Context](/development/reference/python-sdk/platform-context) / Permissions +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / Permissions ```py from agentstack_sdk.platform.context import Permissions ``` diff --git a/docs/development/reference/python-sdk/platform-new.mdx b/docs/development/reference/python-sdk/platform-new.mdx new file mode 100644 index 0000000000..32668be1e0 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new.mdx @@ -0,0 +1,211 @@ +--- +title: "Platform" +description: "Clients for files, vector stores, contexts, providers, and more" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} + +```py +from agentstack_sdk.platform import PlatformClient, SystemConfiguration, AuthorizationCodeRequest # ... +``` +## Submodules + + + + Shared types and utilities + + + Context management + + +--- + +## Client +### Classes + + + + + +### Functions + + + + + + + + + +--- + +## Configuration +### Classes + + + + + +--- + +## Connector +### Classes + + + + + + + + + + + + + +### Functions + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `UuidStr` | *special_form* | `Annotated[UUID \| str, BeforeValidator(uuid_to_str)]` | + +--- + +## File +### Classes + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `ExtractionFormatLiteral` | *special_form* | `Literal['markdown', 'vendor_specific_json']` | + +--- + +## Model Provider +### Classes + + + + + + + + + + + + + +--- + +## Provider +### Classes + + + + + + + + + + + +--- + +## Provider Build +### Classes + + + + + + + + + + + + + + + +### Constants & Variables + +| Name | Kind | Type / Definition | +|------|------|------| +| `OnCompleteAction` | *type_alias* | `AddProvider \| UpdateProvider \| NoAction` | + +--- + +## Provider Discovery +### Classes + + + + + + + +--- + +## User +### Classes + + + + + + + + + +--- + +## User Feedback +### Classes + + + + + + + +--- + +## Vector Store +### Classes + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/AddProvider.mdx b/docs/development/reference/python-sdk/platform-new/AddProvider.mdx new file mode 100644 index 0000000000..27b646007f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/AddProvider.mdx @@ -0,0 +1,25 @@ +--- +title: "AddProvider" +description: "Will add a new provider or update an existing one with the same base docker image ID" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / AddProvider +```py +from agentstack_sdk.platform import AddProvider +``` +**Bases:** `BaseModel` +(docker registry + repository, excluding tag) +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['add_provider']` | `'add_provider'` | +| `auto_stop_timeout_sec` | `int \| None` | `pydantic.Field(default=None, gt=0, le=60...` | +| `variables` | `dict[str, str] \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform-new/AuthorizationCodeRequest.mdx b/docs/development/reference/python-sdk/platform-new/AuthorizationCodeRequest.mdx new file mode 100644 index 0000000000..1219044429 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/AuthorizationCodeRequest.mdx @@ -0,0 +1,23 @@ +--- +title: "AuthorizationCodeRequest" +description: "Authorization request for code-based OAuth flow" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / AuthorizationCodeRequest +```py +from agentstack_sdk.platform import AuthorizationCodeRequest +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['code']` | `'code'` | +| `authorization_endpoint` | `AnyUrl` | — | diff --git a/docs/development/reference/python-sdk/platform-new/BuildConfiguration.mdx b/docs/development/reference/python-sdk/platform-new/BuildConfiguration.mdx new file mode 100644 index 0000000000..f866791d60 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/BuildConfiguration.mdx @@ -0,0 +1,22 @@ +--- +title: "BuildConfiguration" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / BuildConfiguration +```py +from agentstack_sdk.platform import BuildConfiguration +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `dockerfile_path` | `Path \| None` | `Field(default=None, description='Path to...` | diff --git a/docs/development/reference/python-sdk/platform-new/BuildState.mdx b/docs/development/reference/python-sdk/platform-new/BuildState.mdx new file mode 100644 index 0000000000..06f526fab2 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/BuildState.mdx @@ -0,0 +1,26 @@ +--- +title: "BuildState" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / BuildState +```py +from agentstack_sdk.platform import BuildState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `MISSING` | — | `'missing'` | +| `IN_PROGRESS` | — | `'in_progress'` | +| `BUILD_COMPLETED` | — | `'build_completed'` | +| `COMPLETED` | — | `'completed'` | +| `FAILED` | — | `'failed'` | diff --git a/docs/development/reference/python-sdk/platform-new/ChangeRoleResponse.mdx b/docs/development/reference/python-sdk/platform-new/ChangeRoleResponse.mdx new file mode 100644 index 0000000000..41dabeef9c --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ChangeRoleResponse.mdx @@ -0,0 +1,23 @@ +--- +title: "ChangeRoleResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ChangeRoleResponse +```py +from agentstack_sdk.platform import ChangeRoleResponse +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `user_id` | `str` | — | +| `new_role` | `UserRole` | — | diff --git a/docs/development/reference/python-sdk/platform-new/Connector.mdx b/docs/development/reference/python-sdk/platform-new/Connector.mdx new file mode 100644 index 0000000000..0367c6d793 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/Connector.mdx @@ -0,0 +1,234 @@ +--- +title: "Connector" +description: "Represents a configured connector instance" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Connector +```py +from agentstack_sdk.platform import Connector +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | — | +| `url` | `AnyUrl` | — | +| `state` | `ConnectorState` | — | +| `auth_request` | `AuthorizationCodeRequest \| None` | `None` | +| `disconnect_reason` | `str \| None` | `None` | +| `metadata` | `Metadata \| None` | `None` | +| `created_at` | `AwareDatetime \| None` | `None` | +| `updated_at` | `AwareDatetime \| None` | `None` | +| `created_by` | `UUID \| None` | `None` | + +## Methods + + + + + + +Create a new connector. + +Args: + url: The URL of the connector/MCP server + client_id: OAuth client ID (optional) + client_secret: OAuth client secret (optional) + metadata: Additional metadata for the connector (optional) + match_preset: Whether to match against preset connectors + client: Optional PlatformClient instance + +Returns: + The created Connector instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `url` | `AnyUrl \| str` | — | +| `client_id` | `str \| None` | — | +| `client_secret` | `str \| None` | — | +| `metadata` | `Metadata \| None` | — | +| `match_preset` | `bool` | `True` | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +List all connectors for the current user. + +Returns: + A paginated list of Connector instances +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['Connector']` + + + +Read a specific connector by ID. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Delete a connector. + +Args: + client: Optional PlatformClient instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +This is just a syntactic sugar for calling Connector.get(). +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Wait for the connector to reach connected state. + +This is useful after calling connect() and opening the browser for OAuth. +It will poll the server until the connector reaches 'connected' state or +timeout is exceeded. + +Args: + poll_interval: Seconds between polls (default: 2) + client: Optional PlatformClient instance + +Returns: + Updated Connector instance when connected + +Raises: + TimeoutError: If connector doesn't reach connected state within timeout (300 seconds) +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `state` | `ConnectorState` | `ConnectorState.connected` | +| `poll_interval` | `int` | `1` | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `poll_interval` | `int` | `1` | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +Connect a connector (establish authorization). + +If the connector requires OAuth authorization, this will automatically +open the browser with the authorization endpoint. + +Args: + redirect_url: OAuth redirect URL (optional) + access_token: OAuth access token (optional) + client: Optional PlatformClient instance + +Returns: + The updated Connector instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `redirect_url` | `AnyUrl \| str \| None` | — | +| `access_token` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Disconnect a connector. + +Args: + client: Optional PlatformClient instance + +Returns: + The updated Connector instance +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Connector'` + + + +Proxy a streaming request through to the connector's MCP endpoint. + +This allows direct communication with the Model Context Protocol server +exposed by the connector. The response is streamed to avoid loading +large responses into memory. + +Args: + method: HTTP method (GET, POST, etc.) + headers: Optional HTTP headers to include + content: Optional request body content + client: Optional PlatformClient instance + +Yields: + Response content chunks as bytes +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `method` | `str` | — | +| `headers` | `dict \| None` | — | +| `content` | `bytes \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[MCPProxyResponse]` + + + +List all available connector presets. + +Returns: + A paginated list of ConnectorPreset instances +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['ConnectorPreset']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/ConnectorPreset.mdx b/docs/development/reference/python-sdk/platform-new/ConnectorPreset.mdx new file mode 100644 index 0000000000..6d7c153a5f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ConnectorPreset.mdx @@ -0,0 +1,23 @@ +--- +title: "ConnectorPreset" +description: "Represents a preset connector configuration" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ConnectorPreset +```py +from agentstack_sdk.platform import ConnectorPreset +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `url` | `AnyUrl` | — | +| `metadata` | `Metadata \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform-new/ConnectorState.mdx b/docs/development/reference/python-sdk/platform-new/ConnectorState.mdx new file mode 100644 index 0000000000..fae65437d7 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ConnectorState.mdx @@ -0,0 +1,25 @@ +--- +title: "ConnectorState" +description: "Enumeration of possible connector states" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ConnectorState +```py +from agentstack_sdk.platform import ConnectorState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `created` | — | `'created'` | +| `auth_required` | — | `'auth_required'` | +| `connected` | — | `'connected'` | +| `disconnected` | — | `'disconnected'` | diff --git a/docs/development/reference/python-sdk/platform-new/DiscoveryState.mdx b/docs/development/reference/python-sdk/platform-new/DiscoveryState.mdx new file mode 100644 index 0000000000..999a7181cc --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/DiscoveryState.mdx @@ -0,0 +1,25 @@ +--- +title: "DiscoveryState" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / DiscoveryState +```py +from agentstack_sdk.platform import DiscoveryState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `PENDING` | — | `'pending'` | +| `IN_PROGRESS` | — | `'in_progress'` | +| `COMPLETED` | — | `'completed'` | +| `FAILED` | — | `'failed'` | diff --git a/docs/development/reference/python-sdk/platform-new/EnvVar.mdx b/docs/development/reference/python-sdk/platform-new/EnvVar.mdx new file mode 100644 index 0000000000..24dd6a6535 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/EnvVar.mdx @@ -0,0 +1,24 @@ +--- +title: "EnvVar" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / EnvVar +```py +from agentstack_sdk.platform import EnvVar +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `name` | `str` | — | +| `description` | `str \| None` | `None` | +| `required` | `bool` | `False` | diff --git a/docs/development/reference/python-sdk/platform-new/ExtractedFileInfo.mdx b/docs/development/reference/python-sdk/platform-new/ExtractedFileInfo.mdx new file mode 100644 index 0000000000..fffc833b8f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ExtractedFileInfo.mdx @@ -0,0 +1,23 @@ +--- +title: "ExtractedFileInfo" +description: "Information about an extracted file" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ExtractedFileInfo +```py +from agentstack_sdk.platform import ExtractedFileInfo +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `file_id` | `str` | — | +| `format` | `ExtractionFormatLiteral \| None` | — | diff --git a/docs/development/reference/python-sdk/platform-new/Extraction.mdx b/docs/development/reference/python-sdk/platform-new/Extraction.mdx new file mode 100644 index 0000000000..21778c4e52 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/Extraction.mdx @@ -0,0 +1,31 @@ +--- +title: "Extraction" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Extraction +```py +from agentstack_sdk.platform import Extraction +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `file_id` | `str` | — | +| `extracted_files` | `builtins.list[ExtractedFileInfo]` | `pydantic.Field(default_factory=list)` | +| `status` | `Literal['pending', 'in_progress', 'completed', 'failed', 'cancelled']` | `'pending'` | +| `job_id` | `str \| None` | `None` | +| `error_message` | `str \| None` | `None` | +| `extraction_metadata` | `dict[str, typing.Any] \| None` | `None` | +| `started_at` | `AwareDatetime \| None` | `None` | +| `finished_at` | `AwareDatetime \| None` | `None` | +| `created_at` | `AwareDatetime` | — | diff --git a/docs/development/reference/python-sdk/platform-new/File.mdx b/docs/development/reference/python-sdk/platform-new/File.mdx new file mode 100644 index 0000000000..cd96a3dd08 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/File.mdx @@ -0,0 +1,164 @@ +--- +title: "File" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / File +```py +from agentstack_sdk.platform import File +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `filename` | `str` | — | +| `content_type` | `str` | — | +| `file_size_bytes` | `int` | — | +| `created_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | +| `file_type` | `Literal['user_upload', 'extracted_text']` | — | +| `parent_file_id` | `str \| None` | `None` | +| `url` | `PlatformFileUrl` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `filename` | `str` | — | +| `content` | `BinaryIO \| bytes` | — | +| `content_type` | `str` | `'application/octet-stream'` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'File'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'File'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `stream` | `bool` | `False` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `AsyncIterator[LoadedFile]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `stream` | `bool` | `False` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `AsyncIterator[LoadedFile]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `stream` | `bool` | `False` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `AsyncIterator[LoadedFile]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `formats` | `builtins.list[ExtractionFormatLiteral] \| None` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `Extraction` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `Extraction` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Returns:** `FilePart` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `content_type` | `str \| None` | — | +| `filename_search` | `str \| None` | — | +| `page_token` | `str \| None` | — | +| `limit` | `int \| None` | — | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | +| `order_by` | `Literal['created_at'] \| Literal['filename'] \| Literal['file_size_bytes'] \| None` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `PaginatedResult['File']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/ListUserFeedbackResponse.mdx b/docs/development/reference/python-sdk/platform-new/ListUserFeedbackResponse.mdx new file mode 100644 index 0000000000..52f3412b1f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ListUserFeedbackResponse.mdx @@ -0,0 +1,17 @@ +--- +title: "ListUserFeedbackResponse" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ListUserFeedbackResponse +```py +from agentstack_sdk.platform import ListUserFeedbackResponse +``` +**Bases:** `PaginatedResult[UserFeedback]` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/MCPProxyResponse.mdx b/docs/development/reference/python-sdk/platform-new/MCPProxyResponse.mdx new file mode 100644 index 0000000000..ff8440e6dd --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/MCPProxyResponse.mdx @@ -0,0 +1,24 @@ +--- +title: "MCPProxyResponse" +description: "Response from an MCP proxy request with headers and streaming content" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / MCPProxyResponse +```py +from agentstack_sdk.platform import MCPProxyResponse +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `headers` | `Annotated[dict[str, str], Field(description='HTTP headers from the proxy response')]` | — | +| `status_code` | `Annotated[int, Field(description='HTTP status code from the proxy response')]` | — | +| `chunk` | `Annotated[bytes, Field(description='Bytes chunk from streaming response content')]` | — | diff --git a/docs/development/reference/python-sdk/platform-new/ModelCapability.mdx b/docs/development/reference/python-sdk/platform-new/ModelCapability.mdx new file mode 100644 index 0000000000..53a28b2aed --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ModelCapability.mdx @@ -0,0 +1,23 @@ +--- +title: "ModelCapability" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ModelCapability +```py +from agentstack_sdk.platform import ModelCapability +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `LLM` | — | `'llm'` | +| `EMBEDDING` | — | `'embedding'` | diff --git a/docs/development/reference/python-sdk/platform-new/ModelProvider.mdx b/docs/development/reference/python-sdk/platform-new/ModelProvider.mdx new file mode 100644 index 0000000000..36555e55d6 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ModelProvider.mdx @@ -0,0 +1,97 @@ +--- +title: "ModelProvider" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ModelProvider +```py +from agentstack_sdk.platform import ModelProvider +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `name` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | +| `type` | `ModelProviderType` | — | +| `base_url` | `HttpUrl` | — | +| `watsonx_project_id` | `str \| None` | `None` | +| `watsonx_space_id` | `str \| None` | `None` | +| `created_at` | `AwareDatetime` | — | +| `capabilities` | `set[ModelCapability]` | — | +| `state` | `ModelProviderState` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str \| None` | — | +| `description` | `str \| None` | — | +| `type` | `ModelProviderType` | — | +| `base_url` | `str \| pydantic.HttpUrl` | — | +| `watsonx_project_id` | `str \| None` | — | +| `watsonx_space_id` | `str \| None` | — | +| `api_key` | `str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ModelProvider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ModelProvider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `capability` | `ModelCapability` | `ModelCapability.LLM` | +| `suggested_models` | `tuple[str, ...] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `builtins.list[ModelWithScore]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `builtins.list['ModelProvider']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/ModelProviderState.mdx b/docs/development/reference/python-sdk/platform-new/ModelProviderState.mdx new file mode 100644 index 0000000000..8e6cd965f8 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ModelProviderState.mdx @@ -0,0 +1,23 @@ +--- +title: "ModelProviderState" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ModelProviderState +```py +from agentstack_sdk.platform import ModelProviderState +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `ONLINE` | — | `'online'` | +| `OFFLINE` | — | `'offline'` | diff --git a/docs/development/reference/python-sdk/platform-new/ModelProviderType.mdx b/docs/development/reference/python-sdk/platform-new/ModelProviderType.mdx new file mode 100644 index 0000000000..bf46b0401f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ModelProviderType.mdx @@ -0,0 +1,42 @@ +--- +title: "ModelProviderType" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ModelProviderType +```py +from agentstack_sdk.platform import ModelProviderType +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `ANTHROPIC` | — | `'anthropic'` | +| `CEREBRAS` | — | `'cerebras'` | +| `CHUTES` | — | `'chutes'` | +| `COHERE` | — | `'cohere'` | +| `DEEPSEEK` | — | `'deepseek'` | +| `GEMINI` | — | `'gemini'` | +| `GITHUB` | — | `'github'` | +| `GROQ` | — | `'groq'` | +| `WATSONX` | — | `'watsonx'` | +| `JAN` | — | `'jan'` | +| `MISTRAL` | — | `'mistral'` | +| `MOONSHOT` | — | `'moonshot'` | +| `NVIDIA` | — | `'nvidia'` | +| `OLLAMA` | — | `'ollama'` | +| `OPENAI` | — | `'openai'` | +| `OPENROUTER` | — | `'openrouter'` | +| `PERPLEXITY` | — | `'perplexity'` | +| `TOGETHER` | — | `'together'` | +| `VOYAGE` | — | `'voyage'` | +| `RITS` | — | `'rits'` | +| `OTHER` | — | `'other'` | diff --git a/docs/development/reference/python-sdk/platform-new/ModelWithScore.mdx b/docs/development/reference/python-sdk/platform-new/ModelWithScore.mdx new file mode 100644 index 0000000000..14120b28a7 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ModelWithScore.mdx @@ -0,0 +1,23 @@ +--- +title: "ModelWithScore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ModelWithScore +```py +from agentstack_sdk.platform import ModelWithScore +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `model_id` | `str` | — | +| `score` | `float` | — | diff --git a/docs/development/reference/python-sdk/platform-new/NoAction.mdx b/docs/development/reference/python-sdk/platform-new/NoAction.mdx new file mode 100644 index 0000000000..26db7f09c7 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/NoAction.mdx @@ -0,0 +1,22 @@ +--- +title: "NoAction" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / NoAction +```py +from agentstack_sdk.platform import NoAction +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['no_action']` | `'no_action'` | diff --git a/docs/development/reference/python-sdk/platform-new/PlatformClient.mdx b/docs/development/reference/python-sdk/platform-new/PlatformClient.mdx new file mode 100644 index 0000000000..a143daf63c --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/PlatformClient.mdx @@ -0,0 +1,59 @@ +--- +title: "PlatformClient" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / PlatformClient +```py +from agentstack_sdk.platform import PlatformClient +``` +**Bases:** `AsyncClient` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `context_id` | `str \| None` | `context_id` | + +## Methods + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `context_id` | `str \| None` | — | +| `auth_token` | `str \| Secret[str] \| None` | — | +| `auth` | `AuthTypes \| None` | — | +| `params` | `QueryParamTypes \| None` | — | +| `headers` | `HeaderTypes \| None` | — | +| `cookies` | `CookieTypes \| None` | — | +| `verify` | `SSLContext \| str \| bool` | `True` | +| `cert` | `CertTypes \| None` | — | +| `http1` | `bool` | `True` | +| `http2` | `bool` | `False` | +| `proxy` | `ProxyTypes \| None` | — | +| `mounts` | `None \| Mapping[str, AsyncBaseTransport \| None]` | — | +| `timeout` | `TimeoutTypes` | `DEFAULT_SDK_TIMEOUT` | +| `follow_redirects` | `bool` | `False` | +| `limits` | `Limits` | `DEFAULT_LIMITS` | +| `max_redirects` | `int` | `DEFAULT_MAX_REDIRECTS` | +| `event_hooks` | `None \| Mapping[str, list[EventHook]]` | — | +| `base_url` | `URL \| str` | `''` | +| `transport` | `AsyncBaseTransport \| None` | — | +| `trust_env` | `bool` | `True` | +| `default_encoding` | `str \| typing.Callable[[bytes], str]` | `'utf-8'` | + +**Returns:** `None` + + + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/Provider.mdx b/docs/development/reference/python-sdk/platform-new/Provider.mdx new file mode 100644 index 0000000000..f1bd20203f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/Provider.mdx @@ -0,0 +1,166 @@ +--- +title: "Provider" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Provider +```py +from agentstack_sdk.platform import Provider +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `auto_stop_timeout` | `timedelta` | — | +| `source` | `str` | — | +| `origin` | `str` | — | +| `version_info` | `VersionInfo` | `pydantic.Field(default_factory=VersionIn...` | +| `registry` | `str \| None` | `None` | +| `created_at` | `AwareDatetime` | — | +| `updated_at` | `AwareDatetime` | — | +| `last_active_at` | `AwareDatetime` | — | +| `agent_card` | `AgentCard` | — | +| `state` | `Literal['missing', 'starting', 'ready', 'running', 'error', 'online', 'offline']` | `'missing'` | +| `managed` | `bool` | — | +| `last_error` | `ProviderErrorMessage \| None` | `None` | +| `created_by` | `UUID` | — | +| `missing_configuration` | `builtins.list[EnvVar]` | `pydantic.Field(default_factory=list)` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `agent_card` | `AgentCard \| None` | — | +| `origin` | `str \| None` | — | +| `auto_stop_timeout` | `timedelta \| None` | — | +| `variables` | `dict[str, str] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str \| None` | — | +| `agent_card` | `AgentCard \| None` | — | +| `origin` | `str \| None` | — | +| `auto_stop_timeout` | `timedelta \| None` | — | +| `variables` | `dict[str, str] \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `agent_card` | `AgentCard \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Provider'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `variables` | `dict[str, str \| None] \| dict[str, str]` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[dict[str, typing.Any]]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `dict[str, str]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `origin` | `str \| None` | — | +| `user_owned` | `bool \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `builtins.list['Provider']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/ProviderBuild.mdx b/docs/development/reference/python-sdk/platform-new/ProviderBuild.mdx new file mode 100644 index 0000000000..eeefd1bb91 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ProviderBuild.mdx @@ -0,0 +1,108 @@ +--- +title: "ProviderBuild" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ProviderBuild +```py +from agentstack_sdk.platform import ProviderBuild +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `created_at` | `AwareDatetime` | — | +| `status` | `BuildState` | — | +| `source` | `ResolvedGithubUrl` | — | +| `destination` | `str` | — | +| `provider_id` | `str \| None` | `None` | +| `build_configuration` | `BuildConfiguration \| None` | `None` | +| `created_by` | `str` | — | +| `error_message` | `str \| None` | `None` | +| `provider_origin` | `str` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `on_complete` | `OnCompleteAction \| None` | — | +| `build_configuration` | `BuildConfiguration \| None` | — | + +**Returns:** `'ProviderBuild'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `location` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `on_complete` | `OnCompleteAction \| None` | — | + +**Returns:** `'ProviderBuild'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `AsyncIterator[dict[str, Any]]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ProviderBuild'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `page_token` | `str \| None` | — | +| `limit` | `int \| None` | — | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | +| `user_owned` | `bool \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['ProviderBuild']` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/ProviderDiscovery.mdx b/docs/development/reference/python-sdk/platform-new/ProviderDiscovery.mdx new file mode 100644 index 0000000000..0558d2caa9 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ProviderDiscovery.mdx @@ -0,0 +1,56 @@ +--- +title: "ProviderDiscovery" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ProviderDiscovery +```py +from agentstack_sdk.platform import ProviderDiscovery +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | — | +| `created_at` | `AwareDatetime` | — | +| `status` | `DiscoveryState` | — | +| `docker_image` | `str` | — | +| `created_by` | `UUID` | — | +| `agent_card` | `AgentCard \| None` | `None` | +| `error_message` | `str \| None` | `None` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `docker_image` | `str` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ProviderDiscovery'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ProviderDiscovery'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/ProviderErrorMessage.mdx b/docs/development/reference/python-sdk/platform-new/ProviderErrorMessage.mdx new file mode 100644 index 0000000000..ccf24388f3 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/ProviderErrorMessage.mdx @@ -0,0 +1,22 @@ +--- +title: "ProviderErrorMessage" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / ProviderErrorMessage +```py +from agentstack_sdk.platform import ProviderErrorMessage +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `message` | `str` | — | diff --git a/docs/development/reference/python-sdk/platform-new/SystemConfiguration.mdx b/docs/development/reference/python-sdk/platform-new/SystemConfiguration.mdx new file mode 100644 index 0000000000..fa7897859c --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/SystemConfiguration.mdx @@ -0,0 +1,57 @@ +--- +title: "SystemConfiguration" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / SystemConfiguration +```py +from agentstack_sdk.platform import SystemConfiguration +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `default_llm_model` | `str \| None` | `None` | +| `default_embedding_model` | `str \| None` | `None` | +| `updated_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | + +## Methods + + + + + + +Get the current system configuration. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'SystemConfiguration'` + + + +Update the system configuration. +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `default_llm_model` | `str \| None` | — | +| `default_embedding_model` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'SystemConfiguration'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/UpdateProvider.mdx b/docs/development/reference/python-sdk/platform-new/UpdateProvider.mdx new file mode 100644 index 0000000000..5e9f4e19cb --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/UpdateProvider.mdx @@ -0,0 +1,23 @@ +--- +title: "UpdateProvider" +description: "Will update provider specified by ID" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / UpdateProvider +```py +from agentstack_sdk.platform import UpdateProvider +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `type` | `Literal['update_provider']` | `'update_provider'` | +| `provider_id` | `UUID` | — | diff --git a/docs/development/reference/python-sdk/platform-new/User.mdx b/docs/development/reference/python-sdk/platform-new/User.mdx new file mode 100644 index 0000000000..b04f0da8fe --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/User.mdx @@ -0,0 +1,67 @@ +--- +title: "User" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / User +```py +from agentstack_sdk.platform import User +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `role` | `UserRole` | — | +| `email` | `str` | — | +| `created_at` | `AwareDatetime` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'User'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `email` | `str \| None` | — | +| `limit` | `int` | `40` | +| `page_token` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `PaginatedResult['User']` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `user_id` | `str` | — | +| `new_role` | `UserRole` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `ChangeRoleResponse` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/UserFeedback.mdx b/docs/development/reference/python-sdk/platform-new/UserFeedback.mdx new file mode 100644 index 0000000000..078b47e93c --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/UserFeedback.mdx @@ -0,0 +1,51 @@ +--- +title: "UserFeedback" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / UserFeedback +```py +from agentstack_sdk.platform import UserFeedback +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `UUID` | — | +| `provider_id` | `UUID` | — | +| `task_id` | `UUID` | — | +| `context_id` | `UUID` | — | +| `rating` | `int` | — | +| `message` | `str` | — | +| `comment` | `str \| None` | `None` | +| `comment_tags` | `builtins.list[str] \| None` | `None` | +| `created_at` | `datetime` | — | +| `agent_name` | `str` | — | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `provider_id` | `str \| None` | — | +| `limit` | `int` | `50` | +| `after_cursor` | `str \| None` | — | +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'ListUserFeedbackResponse'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/UserRole.mdx b/docs/development/reference/python-sdk/platform-new/UserRole.mdx new file mode 100644 index 0000000000..99b59dff27 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/UserRole.mdx @@ -0,0 +1,24 @@ +--- +title: "UserRole" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / UserRole +```py +from agentstack_sdk.platform import UserRole +``` +**Bases:** `StrEnum` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `ADMIN` | — | `'admin'` | +| `DEVELOPER` | — | `'developer'` | +| `USER` | — | `'user'` | diff --git a/docs/development/reference/python-sdk/platform-new/Variables.mdx b/docs/development/reference/python-sdk/platform-new/Variables.mdx new file mode 100644 index 0000000000..ce6b023381 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/Variables.mdx @@ -0,0 +1,51 @@ +--- +title: "Variables" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Variables +```py +from agentstack_sdk.platform import Variables +``` +**Bases:** `dict[str, str]` +## Methods + + + + + + +Save variables to the Agent Stack platform. Does not delete keys unless explicitly set to None. + +Can be used as a class method: Variables.save(\{"key": "value", ...\}) +...or as an instance method: variables.save() +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `None` + + + +Load variables from the Agent Stack platform. + +Can be used as a class method: variables = Variables.load() +...or as an instance method to update the instance: variables.load() +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | + +**Returns:** `'Variables'` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/VectorStore.mdx b/docs/development/reference/python-sdk/platform-new/VectorStore.mdx new file mode 100644 index 0000000000..4d298e8886 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/VectorStore.mdx @@ -0,0 +1,120 @@ +--- +title: "VectorStore" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / VectorStore +```py +from agentstack_sdk.platform import VectorStore +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `name` | `str \| None` | `None` | +| `model_id` | `str` | — | +| `dimension` | `int` | — | +| `created_at` | `AwareDatetime` | — | +| `last_active_at` | `AwareDatetime` | — | +| `created_by` | `str` | — | +| `stats` | `VectorStoreStats \| None` | `None` | + +## Methods + + + + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `name` | `str` | — | +| `dimension` | `int` | — | +| `model_id` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'VectorStore'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `'VectorStore'` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `items` | `list[VectorStoreItem]` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `query_vector` | `list[float]` | — | +| `limit` | `int` | `10` | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `list[VectorStoreSearchResult]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `list[VectorStoreDocument]` + + + +**Parameters** + +| Name | Type | Default | +|------|------|---------| +| `document_id` | `str` | — | +| `client` | `PlatformClient \| None` | — | +| `context_id` | `str \| None \| Literal['auto']` | `'auto'` | + +**Returns:** `None` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/VectorStoreDocument.mdx b/docs/development/reference/python-sdk/platform-new/VectorStoreDocument.mdx new file mode 100644 index 0000000000..a2b0c85380 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/VectorStoreDocument.mdx @@ -0,0 +1,26 @@ +--- +title: "VectorStoreDocument" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / VectorStoreDocument +```py +from agentstack_sdk.platform import VectorStoreDocument +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | — | +| `vector_store_id` | `str` | — | +| `file_id` | `str \| None` | `None` | +| `usage_bytes` | `int \| None` | `None` | +| `created_at` | `AwareDatetime` | — | diff --git a/docs/development/reference/python-sdk/platform-new/VectorStoreItem.mdx b/docs/development/reference/python-sdk/platform-new/VectorStoreItem.mdx new file mode 100644 index 0000000000..2a97736ef2 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/VectorStoreItem.mdx @@ -0,0 +1,40 @@ +--- +title: "VectorStoreItem" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / VectorStoreItem +```py +from agentstack_sdk.platform import VectorStoreItem +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `id` | `str` | `pydantic.Field(default_factory=(lambda: ...` | +| `document_id` | `str` | — | +| `document_type` | `Literal['platform_file', 'external'] \| None` | `'platform_file'` | +| `model_id` | `str \| typing.Literal['platform']` | `'platform'` | +| `text` | `str` | — | +| `embedding` | `list[float]` | — | +| `metadata` | `Metadata \| None` | `None` | + +## Methods + + + + + + +Validate that document_id is a valid UUID when document_type is platform_file. +**Returns:** `Self` + + \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/VectorStoreSearchResult.mdx b/docs/development/reference/python-sdk/platform-new/VectorStoreSearchResult.mdx new file mode 100644 index 0000000000..64bb9aca6b --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/VectorStoreSearchResult.mdx @@ -0,0 +1,23 @@ +--- +title: "VectorStoreSearchResult" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / VectorStoreSearchResult +```py +from agentstack_sdk.platform import VectorStoreSearchResult +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `item` | `VectorStoreItem` | — | +| `score` | `float` | — | diff --git a/docs/development/reference/python-sdk/platform-new/VectorStoreStats.mdx b/docs/development/reference/python-sdk/platform-new/VectorStoreStats.mdx new file mode 100644 index 0000000000..0a4e8c95ba --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/VectorStoreStats.mdx @@ -0,0 +1,23 @@ +--- +title: "VectorStoreStats" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / VectorStoreStats +```py +from agentstack_sdk.platform import VectorStoreStats +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `usage_bytes` | `int` | — | +| `num_documents` | `int` | — | diff --git a/docs/development/reference/python-sdk/platform-new/VersionInfo.mdx b/docs/development/reference/python-sdk/platform-new/VersionInfo.mdx new file mode 100644 index 0000000000..bb084d8b83 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/VersionInfo.mdx @@ -0,0 +1,23 @@ +--- +title: "VersionInfo" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / VersionInfo +```py +from agentstack_sdk.platform import VersionInfo +``` +**Bases:** `BaseModel` +## Class Attributes + +| Attribute | Type | Default | +|-------|------|---------| +| `docker` | `ResolvedDockerImageID \| None` | `None` | +| `github` | `ResolvedGithubUrl \| None` | `None` | diff --git a/docs/development/reference/python-sdk/platform-new/get_platform_client.mdx b/docs/development/reference/python-sdk/platform-new/get_platform_client.mdx new file mode 100644 index 0000000000..f4777a878a --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/get_platform_client.mdx @@ -0,0 +1,16 @@ +--- +title: "get_platform_client" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / get_platform_client +```py +from agentstack_sdk.platform import get_platform_client +``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/set_platform_client.mdx b/docs/development/reference/python-sdk/platform-new/set_platform_client.mdx new file mode 100644 index 0000000000..05653ac782 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/set_platform_client.mdx @@ -0,0 +1,16 @@ +--- +title: "set_platform_client" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / set_platform_client +```py +from agentstack_sdk.platform import set_platform_client +``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/use_platform_client.mdx b/docs/development/reference/python-sdk/platform-new/use_platform_client.mdx new file mode 100644 index 0000000000..5b5ed078f3 --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/use_platform_client.mdx @@ -0,0 +1,16 @@ +--- +title: "use_platform_client" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / use_platform_client +```py +from agentstack_sdk.platform import use_platform_client +``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform-new/uuid_to_str.mdx b/docs/development/reference/python-sdk/platform-new/uuid_to_str.mdx new file mode 100644 index 0000000000..efdf7418cc --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/uuid_to_str.mdx @@ -0,0 +1,27 @@ +--- +title: "uuid_to_str" +description: "Convert UUID or str to str" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / uuid_to_str +```py +from agentstack_sdk.platform import uuid_to_str +``` +Convert UUID or str to str. +## Parameters + +| Name | Type | Default | +|------|------|---------| +| `v` | `UUID \| str` | — | + +## Returns + +`str` + diff --git a/docs/development/reference/python-sdk/platform-new/validate_metadata.mdx b/docs/development/reference/python-sdk/platform-new/validate_metadata.mdx new file mode 100644 index 0000000000..1a93d97b7f --- /dev/null +++ b/docs/development/reference/python-sdk/platform-new/validate_metadata.mdx @@ -0,0 +1,26 @@ +--- +title: "validate_metadata" +description: "" +--- + +{/* + +⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ + +DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` + +*/} +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / validate_metadata +```py +from agentstack_sdk.platform import validate_metadata +``` +## Parameters + +| Name | Type | Default | +|------|------|---------| +| `metadata` | `dict[str, str \| None]` | — | + +## Returns + +`dict[str, str | None]` + diff --git a/docs/development/reference/python-sdk/server.mdx b/docs/development/reference/python-sdk/server.mdx index efe8027705..7e9cbc0339 100644 --- a/docs/development/reference/python-sdk/server.mdx +++ b/docs/development/reference/python-sdk/server.mdx @@ -14,6 +14,8 @@ DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack ```py from agentstack_sdk.server import Server ``` +## Submodules + Platform authentication middleware diff --git a/docs/docs.json b/docs/docs.json index 71b2a9c1cb..004463ca70 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -163,15 +163,7 @@ } ] }, - { - "group": "Platform API", - "pages": [ - "development/reference/python-sdk/platform-idx", - "development/reference/python-sdk/platform", - "development/reference/python-sdk/platform-common", - "development/reference/python-sdk/platform-context" - ] - }, + "development/reference/python-sdk/platform-new", "development/reference/python-sdk/types", "development/reference/python-sdk/util" ] From f4b2cf4e57e0ed2c277668642833c59833bf1646 Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Wed, 4 Mar 2026 11:51:06 +0100 Subject: [PATCH 6/8] v1 small update Signed-off-by: Jan Jeliga --- apps/agentstack-sdk-py/docs/generate_docs.py | 4 +- .../docs/introspect_exports.py | 256 +++++++++--------- .../MemoryTokenStorageFactory.mdx | 2 +- .../a2a-auth-oauth/OAuthExtensionServer.mdx | 2 +- .../a2a-auth-secrets/SecretsExtensionSpec.mdx | 4 +- .../ToolCallApprovalRequest.mdx | 2 +- .../EmbeddingServiceExtensionSpec.mdx | 4 +- .../FormServiceExtensionServer.mdx | 4 +- .../a2a-services/FormServiceExtensionSpec.mdx | 4 +- .../a2a-services/LLMServiceExtensionSpec.mdx | 4 +- .../a2a-services/MCPServiceExtensionSpec.mdx | 4 +- .../PlatformApiExtensionClient.mdx | 4 +- .../a2a-services/PlatformApiExtensionSpec.mdx | 2 +- .../python-sdk/a2a-tools/ToolCallRequest.mdx | 2 +- .../a2a-ui/CitationExtensionServer.mdx | 4 +- .../a2a-ui/FormRequestExtensionServer.mdx | 4 +- .../a2a-ui/TrajectoryExtensionServer.mdx | 14 +- .../reference/python-sdk/platform-common.mdx | 2 +- .../platform-common/GithubVersionType.mdx | 2 +- .../platform-common/PaginatedResult.mdx | 2 +- .../platform-common/ResolvedDockerImageID.mdx | 2 +- .../platform-common/ResolvedGithubUrl.mdx | 2 +- .../reference/python-sdk/platform-context.mdx | 2 +- .../python-sdk/platform-context/Context.mdx | 50 ++-- .../platform-context/ContextHistoryItem.mdx | 2 +- .../platform-context/ContextPermissions.mdx | 2 +- .../platform-context/ContextToken.mdx | 2 +- .../platform-context/Permissions.mdx | 2 +- .../reference/python-sdk/platform.mdx | 11 +- .../python-sdk/platform/AddProvider.mdx | 2 +- .../platform/AuthorizationCodeRequest.mdx | 2 +- .../platform/BuildConfiguration.mdx | 2 +- .../python-sdk/platform/BuildState.mdx | 2 +- .../platform/ChangeRoleResponse.mdx | 2 +- .../python-sdk/platform/Connector.mdx | 38 +-- .../python-sdk/platform/ConnectorPreset.mdx | 2 +- .../python-sdk/platform/ConnectorState.mdx | 2 +- .../python-sdk/platform/DiscoveryState.mdx | 2 +- .../reference/python-sdk/platform/EnvVar.mdx | 2 +- .../python-sdk/platform/ExtractedFileInfo.mdx | 2 +- .../python-sdk/platform/Extraction.mdx | 2 +- .../reference/python-sdk/platform/File.mdx | 34 +-- .../platform/ListUserFeedbackResponse.mdx | 2 +- .../python-sdk/platform/MCPProxyResponse.mdx | 2 +- .../python-sdk/platform/ModelCapability.mdx | 2 +- .../python-sdk/platform/ModelProvider.mdx | 22 +- .../platform/ModelProviderState.mdx | 2 +- .../python-sdk/platform/ModelProviderType.mdx | 2 +- .../python-sdk/platform/ModelWithScore.mdx | 2 +- .../python-sdk/platform/NoAction.mdx | 2 +- .../python-sdk/platform/PlatformClient.mdx | 24 +- .../python-sdk/platform/Provider.mdx | 48 ++-- .../python-sdk/platform/ProviderBuild.mdx | 28 +- .../python-sdk/platform/ProviderDiscovery.mdx | 6 +- .../platform/ProviderErrorMessage.mdx | 2 +- .../platform/SystemConfiguration.mdx | 10 +- .../python-sdk/platform/UpdateProvider.mdx | 2 +- .../reference/python-sdk/platform/User.mdx | 12 +- .../python-sdk/platform/UserFeedback.mdx | 8 +- .../python-sdk/platform/UserRole.mdx | 2 +- .../python-sdk/platform/Variables.mdx | 6 +- .../python-sdk/platform/VectorStore.mdx | 16 +- .../platform/VectorStoreDocument.mdx | 2 +- .../python-sdk/platform/VectorStoreItem.mdx | 2 +- .../platform/VectorStoreSearchResult.mdx | 2 +- .../python-sdk/platform/VectorStoreStats.mdx | 2 +- .../python-sdk/platform/VersionInfo.mdx | 2 +- .../platform/get_platform_client.mdx | 2 +- .../platform/set_platform_client.mdx | 2 +- .../platform/use_platform_client.mdx | 2 +- .../python-sdk/platform/uuid_to_str.mdx | 2 +- .../python-sdk/platform/validate_metadata.mdx | 2 +- .../PlatformAuthBackend.mdx | 4 +- .../reference/python-sdk/server/AgentRun.mdx | 2 +- .../reference/python-sdk/server/Server.mdx | 62 ++--- .../reference/python-sdk/util/LoadedFile.mdx | 8 +- .../python-sdk/util/LoadedFileWithBytes.mdx | 14 +- .../python-sdk/util/LoadedFileWithUri.mdx | 14 +- docs/docs.json | 2 +- 79 files changed, 411 insertions(+), 410 deletions(-) diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py index 77cca6638e..1ce423adf5 100644 --- a/apps/agentstack-sdk-py/docs/generate_docs.py +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -222,7 +222,7 @@ # ── platform (grouped by sub-module) ────────────────────────────────────── { "json_key": "agentstack_sdk.platform", - "filename": "platform-new", + "filename": "platform", "title": "Platform", "description": "Clients for files, vector stores, contexts, providers, and more", "import_path": "agentstack_sdk.platform", @@ -676,7 +676,7 @@ def main() -> None: symbol_count += 1 module_count = 1 + len(PAGE_CONFIG) - print(f"\nGenerated {module_count} module pages + {symbol_count} symbol pages in {version}/reference/python-sdk/") + print(f"Generated {module_count} module pages + {symbol_count} symbol pages in {args.docs_dir}") if __name__ == "__main__": diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py index aa8af8747d..d23be63768 100644 --- a/apps/agentstack-sdk-py/docs/introspect_exports.py +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -5,6 +5,7 @@ import ast import enum +import functools import json import re import sys @@ -17,9 +18,6 @@ import griffe -SRC_ROOT = Path() - - class ExportItem(BaseModel): model_config = ConfigDict(validate_assignment=True) name: str @@ -54,18 +52,8 @@ def parse_allnames(tree: ast.Module) -> list[str]: return [] -def resolve_absolute(module_path: str) -> Path | None: - """ - Resolve an absolute dotted module path to a filesystem path, but only - if the module lives inside the same package (SRC_ROOT). - """ - pkg_name = SRC_ROOT.name # e.g. "agentstack_sdk" - if not module_path.startswith(pkg_name): - return None - parts = module_path.split(".") - candidate: Path = SRC_ROOT.parent - for part in parts: - candidate = candidate / part +def _resolve_candidate(candidate: Path) -> Path | None: + """Resolve a candidate path to a package directory or .py module, or None.""" if (candidate / "__init__.py").exists(): return candidate if candidate.with_suffix(".py").exists(): @@ -73,6 +61,19 @@ def resolve_absolute(module_path: str) -> Path | None: return None +def resolve_absolute(module_path: str, src_root: Path) -> Path | None: + """ + Resolve an absolute dotted module path to a filesystem path, but only + if the module lives inside the same package (src_root). + """ + if not module_path.startswith(src_root.name): + return None + candidate: Path = src_root.parent + for part in module_path.split("."): + candidate = candidate / part + return _resolve_candidate(candidate) + + def resolve_relative(current_pkg_path: Path, level: int, module_suffix: str | None) -> Path | None: """ Resolve a relative import to an absolute filesystem path. @@ -87,22 +88,16 @@ def resolve_relative(current_pkg_path: Path, level: int, module_suffix: str | No base = base.parent if module_suffix: - parts = module_suffix.split(".") candidate = base - for part in parts: + for part in module_suffix.split("."): candidate = candidate / part else: candidate = base - # Prefer package (directory with __init__.py) over plain module - if (candidate / "__init__.py").exists(): - return candidate - if candidate.with_suffix(".py").exists(): - return candidate.with_suffix(".py") - return None + return _resolve_candidate(candidate) -def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportItem]: +def collect_exports(path: Path, src_root: Path, visited: set[str] | None = None) -> list[ExportItem]: """ Recursively collect effective exports from a file or package directory. @@ -136,7 +131,7 @@ def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportI return [] exports: list[ExportItem] = [] - origin = _path_to_module(parse_file) + origin = _path_to_module(parse_file, src_root) # ── 1. Check for an explicit __all__ ──────────────────────────────────── declared = parse_allnames(tree) @@ -180,9 +175,9 @@ def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportI if node.level == 0: # ── absolute star import from within the same package ──────────── if node.names and node.names[0].name == "*" and node.module: - resolved_abs = resolve_absolute(node.module) + resolved_abs = resolve_absolute(node.module, src_root) if resolved_abs is not None: - child_exports = collect_exports(resolved_abs, visited) + child_exports = collect_exports(resolved_abs, src_root, visited) exports.extend(child_exports) else: # Capture intentional `Name as Name` re-exports @@ -200,12 +195,12 @@ def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportI file=sys.stderr, ) continue - child_exports = collect_exports(resolved, visited) + child_exports = collect_exports(resolved, src_root, visited) exports.extend(child_exports) # ── relative explicit: `from .X import Name as Name` ──────────────── else: - resolved_module = _path_to_module(resolved) if resolved else (node.module or "") + resolved_module = _path_to_module(resolved, src_root) if resolved else (node.module or "") for alias in node.names: if alias.name != "*": exports.append(ExportItem(name=alias.asname or alias.name, origin=resolved_module)) @@ -213,12 +208,12 @@ def collect_exports(path: Path, visited: set[str] | None = None) -> list[ExportI return _deduplicate(exports) -def _path_to_module(path: Path | None) -> str: - """Convert an absolute path under SRC_ROOT.parent to a dotted module name.""" +def _path_to_module(path: Path | None, src_root: Path) -> str: + """Convert an absolute path under src_root.parent to a dotted module name.""" if path is None: return "" try: - rel = path.relative_to(SRC_ROOT.parent) + rel = path.relative_to(src_root.parent) except ValueError: return str(path) parts = list(rel.parts) @@ -239,6 +234,7 @@ def _deduplicate(exports: list[ExportItem]) -> list[ExportItem]: return result +@functools.lru_cache(maxsize=None) def _init_imports_file(init_file: Path, module_stem: str) -> bool: """ Return True if *init_file* contains any import that explicitly references @@ -269,38 +265,45 @@ def _init_imports_file(init_file: Path, module_stem: str) -> bool: # TODO: this might need to change if the logic of how the classes etc. are exposed changes -def trace_package(root: Path) -> dict[str, list[ExportItem]]: +def trace_package(root: Path, src_root: Path) -> dict[str, list[ExportItem]]: """ Walk every __init__.py in the package and compute its effective public API. Also picks up flat .py modules anywhere in the package tree that are NOT already referenced (imported) by the sibling __init__.py. + It is currently not clear what should actually be exposed so this approach takes everything directly + exposed through the __init__ files and adds everything that lies separately alongside this scheme. Returns {dotted_module_path: [ExportItem, ...]}. """ result: dict[str, list[ExportItem]] = {} - - for init_file in sorted(root.rglob("__init__.py")): - if "__pycache__" in init_file.parts: + init_files: list[Path] = [] + other_files: list[Path] = [] + # collect and categorize all .py files under the root (skip __pycache__) + for py_file in sorted(root.rglob("*.py")): + if "__pycache__" in py_file.parts: continue + if py_file.name == "__init__.py": + init_files.append(py_file) + elif not py_file.name.startswith("_"): + other_files.append(py_file) + + # collect all the __init_.py exports, which directly define the main public API of each package + for init_file in init_files: pkg_dir = init_file.parent - module_name = _path_to_module(pkg_dir) - exports = collect_exports(pkg_dir) # fresh visited set per package + module_name = _path_to_module(pkg_dir, src_root) + exports = collect_exports(pkg_dir, src_root) # fresh visited set per package result[module_name] = exports # Also pick up flat .py modules anywhere in the package tree (e.g. a2a/types.py). # Skip a file if the sibling __init__.py already imports from it — those # exports are already captured via the package entry above. - for py_file in sorted(root.rglob("*.py")): - if py_file.name == "__init__.py" or py_file.name.startswith("_"): - continue - if "__pycache__" in py_file.parts: - continue - module_name = _path_to_module(py_file) + for py_file in other_files: + module_name = _path_to_module(py_file, src_root) if module_name in result: continue sibling_init = py_file.parent / "__init__.py" if _init_imports_file(sibling_init, py_file.stem): continue - exports = collect_exports(py_file) + exports = collect_exports(py_file, src_root) if exports: result[module_name] = exports @@ -321,14 +324,17 @@ def _fmt_annotation(ann: Any) -> str | None: def _fmt_docstring(ds: griffe.Docstring | None) -> str | None: if not ds or not ds.value: return None - text = ds.value.strip() - return text + return ds.value.strip() or None FILTER_FUNCTION_LABELS = {"module-attribute"} +_SENTINEL_DEFAULTS = frozenset({"PosOnlyArgsSep", "KwOnlyArgsSep"}) +_MAX_DEFAULT_LEN = 80 -def _serialize_function(fn: griffe.Function) -> dict[str, Any]: + +def _serialize_params(fn: griffe.Function) -> list[dict[str, Any]]: + """Serialize function/method parameters, skipping self/cls.""" params = [] for p in fn.parameters: if p.name in ("self", "cls"): @@ -336,10 +342,16 @@ def _serialize_function(fn: griffe.Function) -> dict[str, Any]: entry: dict[str, Any] = {"name": p.name} if p.annotation: entry["type"] = _fmt_annotation(p.annotation) - if p.default is not None and str(p.default) not in ("PosOnlyArgsSep", "KwOnlyArgsSep"): - entry["default"] = str(p.default) + if p.default is not None and str(p.default) not in _SENTINEL_DEFAULTS: + d = str(p.default) + entry["default"] = d if len(d) <= _MAX_DEFAULT_LEN else d[:_MAX_DEFAULT_LEN] + "..." entry["kind"] = p.kind.value if p.kind and hasattr(p.kind, "value") else str(p.kind) params.append(entry) + return params + + +def _serialize_function(fn: griffe.Function) -> dict[str, Any]: + params = _serialize_params(fn) result: dict[str, Any] = {"kind": "function", "params": params} if fn.returns: @@ -412,11 +424,12 @@ def _serialize_class(cls: griffe.Class) -> dict[str, Any]: if doc: result["docstring"] = doc - # Fields (class-level attributes, excluding private and dunder) - class_attrs = [] + class_attrs: list[dict[str, Any]] = [] + methods: list[dict[str, Any]] = [] + init_assigned: list[dict[str, Any]] | None = None + for name, member in cls.members.items(): - if name.startswith("_"): - continue + is_private = name.startswith("_") actual = member if isinstance(member, griffe.Alias): @@ -425,73 +438,51 @@ def _serialize_class(cls: griffe.Class) -> dict[str, Any]: except Exception: continue - if actual.kind.name != "ATTRIBUTE": - continue - field: dict[str, Any] = {"name": name} - ann = getattr(actual, "annotation", None) - if ann: - field["type"] = _fmt_annotation(ann) - field_doc = _fmt_docstring(actual.docstring) - if field_doc: - field["docstring"] = field_doc - val = getattr(actual, "value", None) - if val is not None: - v = str(val)[:120] - field["default"] = v - if len(v) > 120: - field["default"] += "..." - class_attrs.append(field) + kind_name = actual.kind.name + + # ── class-level attributes (excluding private and dunder) ────────── + if kind_name == "ATTRIBUTE" and not is_private: + field: dict[str, Any] = {"name": name} + ann = getattr(actual, "annotation", None) + if ann: + field["type"] = _fmt_annotation(ann) + field_doc = _fmt_docstring(actual.docstring) + if field_doc: + field["docstring"] = field_doc + val = getattr(actual, "value", None) + # TODO: this might need some change if we find this to be + if val is not None: + v = str(val) + field["default"] = v[:120] + ("..." if len(v) > 120 else "") + class_attrs.append(field) + + # ── public methods (excluding dunder, but including __init__) ─────── + elif kind_name == "FUNCTION" and (not is_private or name == "__init__"): + method_info: dict[str, Any] = {"name": name} + if name == "__init__": + method_info["kind"] = "constructor" + init_assigned = _identify_arguments_from_init(actual) # pyrefly: ignore[bad-argument-type] + elif _is_factory_classmethod(actual, cls.name): # pyrefly: ignore[bad-argument-type] + method_info["kind"] = "constructor" + else: + method_info["kind"] = "method" + params = _serialize_params(actual) # pyrefly: ignore[bad-argument-type] + if params: + method_info["params"] = params + if hasattr(actual, "returns") and actual.returns: + method_info["returns"] = _fmt_annotation(actual.returns) + method_doc = _fmt_docstring(actual.docstring) + if method_doc: + method_info["docstring"] = method_doc + if actual.labels: + method_info["labels"] = sorted(str(l) for l in actual.labels) + methods.append(method_info) + if class_attrs: result["class_attributes"] = class_attrs - - # Public methods (excluding dunder, but including __init__) - methods = [] - for name, member in cls.members.items(): - if name.startswith("_") and name != "__init__": - continue - actual = member - if member.kind.name == "ALIAS": - if hasattr(member, "target"): - actual = member.target - else: - continue - if actual.kind.name != "FUNCTION": - continue - method_info: dict[str, Any] = {"name": name} - if name == "__init__": - method_info["kind"] = "constructor" - # Find self.attribute assignments in the __init__ body - assigned_attributes = _identify_arguments_from_init(actual) # pyrefly: ignore[bad-argument-type] - if assigned_attributes: - class_attrs_names = {attr["name"] for attr in class_attrs} - result["attributes"] = [aa for aa in assigned_attributes if aa["name"] not in class_attrs_names] - - elif _is_factory_classmethod(actual, cls.name): # pyrefly: ignore[bad-argument-type] - method_info["kind"] = "constructor" - else: - method_info["kind"] = "method" - params = [] - if hasattr(actual, "parameters") and actual.parameters: - for p in actual.parameters: - if p.name in ("self", "cls"): - continue - pe: dict[str, Any] = {"name": p.name} - if p.annotation: - pe["type"] = _fmt_annotation(p.annotation) - if p.default is not None and str(p.default) not in ("None", "PosOnlyArgsSep", "KwOnlyArgsSep"): - d = str(p.default) - pe["default"] = d if len(d) <= 80 else d[:80] + "..." - params.append(pe) - if params: - method_info["params"] = params - if hasattr(actual, "returns") and actual.returns: - method_info["returns"] = _fmt_annotation(actual.returns) - method_doc = _fmt_docstring(actual.docstring) - if method_doc: - method_info["docstring"] = method_doc - if actual.labels: - method_info["labels"] = sorted(str(l) for l in actual.labels) - methods.append(method_info) + if init_assigned: + class_attrs_names = {attr["name"] for attr in class_attrs} + result["attributes"] = [aa for aa in init_assigned if aa["name"] not in class_attrs_names] if methods: result["methods"] = methods @@ -528,13 +519,16 @@ class TypingKind(str, enum.Enum): "Concatenate[", ] +_TYPING_KIND_PREFIXES: list[tuple[str, TypingKind]] = [ + ("TypeVar(", TypingKind.TYPE_VAR), + ("NewType(", TypingKind.NEW_TYPE), +] + _VALUE_PREFIX_TO_KIND: list[tuple[str, TypingKind]] = [ *(("typing." + p, TypingKind.SPECIAL_FORM) for p in _SPECIAL_FORM_PREFIXES), *((p, TypingKind.SPECIAL_FORM) for p in _SPECIAL_FORM_PREFIXES), - ("typing.TypeVar(", TypingKind.TYPE_VAR), - ("TypeVar(", TypingKind.TYPE_VAR), - ("typing.NewType(", TypingKind.NEW_TYPE), - ("NewType(", TypingKind.NEW_TYPE), + *(("typing." + prefix, kind) for prefix, kind in _TYPING_KIND_PREFIXES), + *_TYPING_KIND_PREFIXES, ] _TYPE_ALIAS_ANNOTATION_NAMES = {"TypeAlias", "typing.TypeAlias", "typing_extensions.TypeAlias"} @@ -617,9 +611,8 @@ def _lookup_griffe(pkg: griffe.Module, dotted_path: str, name: str) -> griffe.Ob """Resolve dotted_path in the griffe module tree, then look up name.""" try: obj = pkg - # Strip the leading "agentstack_sdk." prefix if present - relative = dotted_path.removeprefix("agentstack_sdk.") - if relative and relative != "agentstack_sdk": + relative = dotted_path.removeprefix(f"{pkg.name}.") + if relative and relative != pkg.name: for part in relative.split("."): obj = obj[part] return obj[name] @@ -728,17 +721,16 @@ def main() -> None: # Allow helper functions (resolve_absolute, _path_to_module) to use the # correct source root when --src-root is overridden. - global SRC_ROOT - SRC_ROOT = Path(args.src_root.resolve()) + src_root = Path(args.src_root.resolve()) - if not SRC_ROOT.exists(): - sys.exit(f"Package source not found at {SRC_ROOT}") + if not src_root.exists(): + sys.exit(f"Package source not found at {src_root}") # ── Phase 1: star-import tracing ───────────────────────────────────────── - api = trace_package(SRC_ROOT) + api = trace_package(src_root, src_root) # ── Phase 2: griffe enrichment ─────────────────────────────────────────── - pkg = griffe.load("agentstack_sdk", search_paths=[str(SRC_ROOT.parent)]) + pkg = griffe.load(src_root.name, search_paths=[str(src_root.parent)]) enriched = enrich_api(api, pkg) out_file: Path = args.output diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx index 682c38c784..a75748e3cb 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth-storage/MemoryTokenStorageFactory.mdx @@ -24,7 +24,7 @@ from agentstack_sdk.a2a.extensions.auth.oauth.storage import MemoryTokenStorageF | Name | Type | Default | |------|------|---------| -| `client_info` | `OAuthClientInformationFull \| None` | — | +| `client_info` | `OAuthClientInformationFull \| None` | `None` | diff --git a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx index da1a7d3319..34494c079e 100644 --- a/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-oauth/OAuthExtensionServer.mdx @@ -32,7 +32,7 @@ from agentstack_sdk.a2a.extensions.auth.oauth import OAuthExtensionServer | Name | Type | Default | |------|------|---------| | `spec` | `OAuthExtensionSpec` | — | -| `token_storage_factory` | `TokenStorageFactory \| None` | — | +| `token_storage_factory` | `TokenStorageFactory \| None` | `None` | **Returns:** `None` diff --git a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx index e66319ae0f..a8edcb6c2a 100644 --- a/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-auth-secrets/SecretsExtensionSpec.mdx @@ -31,8 +31,8 @@ from agentstack_sdk.a2a.extensions.auth.secrets import SecretsExtensionSpec | Name | Type | Default | |------|------|---------| | `name` | `str` | — | -| `key` | `str \| None` | — | -| `description` | `str \| None` | — | +| `key` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | **Returns:** `Self` diff --git a/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx b/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx index 6b177cabec..4bea191c74 100644 --- a/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-interactions/ToolCallApprovalRequest.mdx @@ -39,7 +39,7 @@ from agentstack_sdk.a2a.extensions.interactions import ToolCallApprovalRequest |------|------|---------| | `tool` | `Tool` | — | | `input` | `dict[str, Any] \| None` | — | -| `server` | `Implementation \| None` | — | +| `server` | `Implementation \| None` | `None` | **Returns:** `'ToolCallApprovalRequest'` diff --git a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx index 3c2a397980..28313b63fd 100644 --- a/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/EmbeddingServiceExtensionSpec.mdx @@ -30,8 +30,8 @@ from agentstack_sdk.a2a.extensions.services import EmbeddingServiceExtensionSpec | Name | Type | Default | |------|------|---------| -| `name` | `str \| None` | — | -| `description` | `str \| None` | — | +| `name` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | | `suggested` | `tuple[str, ...]` | `()` | **Returns:** `Self` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx index fa0ff57c48..18a4d1509e 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionServer.mdx @@ -27,7 +27,7 @@ Parse initial_form from form_fulfillments. | Name | Type | Default | |------|------|---------| -| `model` | `type[T] \| None` | — | +| `model` | `type[T] \| None` | `None` | **Returns:** `T | FormResponse | None` @@ -41,7 +41,7 @@ deprecated SettingsExtensionServer.parse_settings_response(). | Name | Type | Default | |------|------|---------| -| `model` | `type[T] \| None` | — | +| `model` | `type[T] \| None` | `None` | **Returns:** `T | SettingsFormResponse | None` diff --git a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx index 9b48ec5e76..c707842057 100644 --- a/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/FormServiceExtensionSpec.mdx @@ -55,8 +55,8 @@ Create form extension demanding both initial_form and settings_form. | Name | Type | Default | |------|------|---------| -| `initial_form` | `FormRender \| None` | — | -| `settings_form` | `SettingsFormRender \| None` | — | +| `initial_form` | `FormRender \| None` | `None` | +| `settings_form` | `SettingsFormRender \| None` | `None` | **Returns:** `Self` diff --git a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx index faa521d449..5889b7c5bd 100644 --- a/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/LLMServiceExtensionSpec.mdx @@ -30,8 +30,8 @@ from agentstack_sdk.a2a.extensions.services import LLMServiceExtensionSpec | Name | Type | Default | |------|------|---------| -| `name` | `str \| None` | — | -| `description` | `str \| None` | — | +| `name` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | | `suggested` | `tuple[str, ...]` | `()` | **Returns:** `Self` diff --git a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx index 24b0254d0f..2070b68b95 100644 --- a/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/MCPServiceExtensionSpec.mdx @@ -31,9 +31,9 @@ from agentstack_sdk.a2a.extensions.services import MCPServiceExtensionSpec | Name | Type | Default | |------|------|---------| | `name` | `str` | `_DEFAULT_DEMAND_NAME` | -| `description` | `str \| None` | — | +| `description` | `str \| None` | `None` | | `suggested` | `tuple[str, ...]` | `()` | -| `allowed_transports` | `list[_TRANSPORT_TYPES] \| None` | — | +| `allowed_transports` | `list[_TRANSPORT_TYPES] \| None` | `None` | **Returns:** `Self` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx index 2118da46d0..20ff33ba74 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionClient.mdx @@ -27,8 +27,8 @@ from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionClient | Name | Type | Default | |------|------|---------| | `auth_token` | `Secret[str] \| str` | — | -| `expires_at` | `AwareDatetime \| None` | — | -| `base_url` | `HttpUrl \| None` | — | +| `expires_at` | `AwareDatetime \| None` | `None` | +| `base_url` | `HttpUrl \| None` | `None` | **Returns:** `dict[str, dict[str, str]]` diff --git a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx index 0292604e17..5b6e807fa2 100644 --- a/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx +++ b/docs/development/reference/python-sdk/a2a-services/PlatformApiExtensionSpec.mdx @@ -30,7 +30,7 @@ from agentstack_sdk.a2a.extensions.services import PlatformApiExtensionSpec | Name | Type | Default | |------|------|---------| -| `params` | `PlatformApiExtensionParams \| None` | — | +| `params` | `PlatformApiExtensionParams \| None` | `None` | **Returns:** `None` diff --git a/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx b/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx index c50092d0d7..338fa6f3e2 100644 --- a/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx +++ b/docs/development/reference/python-sdk/a2a-tools/ToolCallRequest.mdx @@ -38,7 +38,7 @@ from agentstack_sdk.a2a.extensions.tools import ToolCallRequest |------|------|---------| | `tool` | `Tool` | — | | `input` | `dict[str, Any] \| None` | — | -| `server` | `Implementation \| None` | — | +| `server` | `Implementation \| None` | `None` | **Returns:** `'ToolCallRequest'` diff --git a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx index dfffabe7e1..fa0748a135 100644 --- a/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/CitationExtensionServer.mdx @@ -36,8 +36,8 @@ from agentstack_sdk.a2a.extensions.ui import CitationExtensionServer | Name | Type | Default | |------|------|---------| -| `text` | `str \| None` | — | -| `parts` | `list[Part \| TextPart \| FilePart \| DataPart] \| None` | — | +| `text` | `str \| None` | `None` | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart] \| None` | `None` | | `citations` | `list[Citation]` | — | **Returns:** `AgentMessage` diff --git a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx index 8469a77b83..70538617c8 100644 --- a/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/FormRequestExtensionServer.mdx @@ -36,7 +36,7 @@ from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionServer | Name | Type | Default | |------|------|---------| | `form` | `FormRender` | — | -| `model` | `type[T] \| None` | — | +| `model` | `type[T] \| None` | `None` | **Returns:** `T | FormResponse | None` @@ -47,7 +47,7 @@ from agentstack_sdk.a2a.extensions.ui import FormRequestExtensionServer | Name | Type | Default | |------|------|---------| | `message` | `A2AMessage` | — | -| `model` | `type[T] \| None` | — | +| `model` | `type[T] \| None` | `None` | **Returns:** `T | FormResponse | None` diff --git a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx index 557ab34bdb..1fa94ff4d7 100644 --- a/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx +++ b/docs/development/reference/python-sdk/a2a-ui/TrajectoryExtensionServer.mdx @@ -26,9 +26,9 @@ from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionServer | Name | Type | Default | |------|------|---------| -| `title` | `str \| None` | — | -| `content` | `str \| None` | — | -| `group_id` | `str \| None` | — | +| `title` | `str \| None` | `None` | +| `content` | `str \| None` | `None` | +| `group_id` | `str \| None` | `None` | **Returns:** `Metadata` @@ -38,10 +38,10 @@ from agentstack_sdk.a2a.extensions.ui import TrajectoryExtensionServer | Name | Type | Default | |------|------|---------| -| `text` | `str \| None` | — | -| `parts` | `list[Part \| TextPart \| FilePart \| DataPart] \| None` | — | -| `trajectory_title` | `str \| None` | — | -| `trajectory_content` | `str \| None` | — | +| `text` | `str \| None` | `None` | +| `parts` | `list[Part \| TextPart \| FilePart \| DataPart] \| None` | `None` | +| `trajectory_title` | `str \| None` | `None` | +| `trajectory_content` | `str \| None` | `None` | **Returns:** `AgentMessage` diff --git a/docs/development/reference/python-sdk/platform-common.mdx b/docs/development/reference/python-sdk/platform-common.mdx index de1a334f2f..e59fa6a9a5 100644 --- a/docs/development/reference/python-sdk/platform-common.mdx +++ b/docs/development/reference/python-sdk/platform-common.mdx @@ -10,7 +10,7 @@ description: "Shared types and utilities" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Common +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / Common ```py from agentstack_sdk.platform.common import GithubVersionType, PaginatedResult, ResolvedDockerImageID # ... diff --git a/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx b/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx index ac0b4df857..142a1c1d1c 100644 --- a/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx +++ b/docs/development/reference/python-sdk/platform-common/GithubVersionType.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / GithubVersionType +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Common](/development/reference/python-sdk/platform-common) / GithubVersionType ```py from agentstack_sdk.platform.common import GithubVersionType ``` diff --git a/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx b/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx index bc2d8080ea..2e6922e7dc 100644 --- a/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx +++ b/docs/development/reference/python-sdk/platform-common/PaginatedResult.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / PaginatedResult +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Common](/development/reference/python-sdk/platform-common) / PaginatedResult ```py from agentstack_sdk.platform.common import PaginatedResult ``` diff --git a/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx b/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx index 1e87c0e445..26b56ba198 100644 --- a/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx +++ b/docs/development/reference/python-sdk/platform-common/ResolvedDockerImageID.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / ResolvedDockerImageID +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Common](/development/reference/python-sdk/platform-common) / ResolvedDockerImageID ```py from agentstack_sdk.platform.common import ResolvedDockerImageID ``` diff --git a/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx b/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx index 1ff821e9d7..efc4595a2b 100644 --- a/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx +++ b/docs/development/reference/python-sdk/platform-common/ResolvedGithubUrl.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Common](/development/reference/python-sdk/platform-common) / ResolvedGithubUrl +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Common](/development/reference/python-sdk/platform-common) / ResolvedGithubUrl ```py from agentstack_sdk.platform.common import ResolvedGithubUrl ``` diff --git a/docs/development/reference/python-sdk/platform-context.mdx b/docs/development/reference/python-sdk/platform-context.mdx index 02ba6831d3..369353afea 100644 --- a/docs/development/reference/python-sdk/platform-context.mdx +++ b/docs/development/reference/python-sdk/platform-context.mdx @@ -10,7 +10,7 @@ description: "Context management" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / Context +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / Context ```py from agentstack_sdk.platform.context import Context, ContextHistoryItem, ContextPermissions # ... diff --git a/docs/development/reference/python-sdk/platform-context/Context.mdx b/docs/development/reference/python-sdk/platform-context/Context.mdx index 634698311f..50ae89bd11 100644 --- a/docs/development/reference/python-sdk/platform-context/Context.mdx +++ b/docs/development/reference/python-sdk/platform-context/Context.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / Context +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Context](/development/reference/python-sdk/platform-context) / Context ```py from agentstack_sdk.platform.context import Context ``` @@ -38,9 +38,9 @@ from agentstack_sdk.platform.context import Context | Name | Type | Default | |------|------|---------| -| `metadata` | `Metadata \| None` | — | -| `provider_id` | `str \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `metadata` | `Metadata \| None` | `None` | +| `provider_id` | `str \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Context'` @@ -50,13 +50,13 @@ from agentstack_sdk.platform.context import Context | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | -| `page_token` | `str \| None` | — | -| `limit` | `int \| None` | — | -| `order` | `Literal['asc'] \| Literal['desc'] \| None` | — | -| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | +| `client` | `PlatformClient \| None` | `None` | +| `page_token` | `str \| None` | `None` | +| `limit` | `int \| None` | `None` | +| `order` | `Literal['asc'] \| Literal['desc'] \| None` | `None` | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | `None` | | `include_empty` | `bool` | `True` | -| `provider_id` | `str \| None` | — | +| `provider_id` | `str \| None` | `None` | **Returns:** `PaginatedResult['Context']` @@ -66,7 +66,7 @@ from agentstack_sdk.platform.context import Context | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Context'` @@ -77,7 +77,7 @@ from agentstack_sdk.platform.context import Context | Name | Type | Default | |------|------|---------| | `metadata` | `Metadata \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Context'` @@ -88,7 +88,7 @@ from agentstack_sdk.platform.context import Context | Name | Type | Default | |------|------|---------| | `metadata` | `MetadataPatch \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Context'` @@ -98,7 +98,7 @@ from agentstack_sdk.platform.context import Context | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -112,10 +112,10 @@ Generate token for agent authentication | Name | Type | Default | |------|------|---------| -| `providers` | `builtins.list[str] \| builtins.list[Provider] \| None` | — | -| `client` | `PlatformClient \| None` | — | -| `grant_global_permissions` | `Permissions \| None` | — | -| `grant_context_permissions` | `ContextPermissions \| None` | — | +| `providers` | `builtins.list[str] \| builtins.list[Provider] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | +| `grant_global_permissions` | `Permissions \| None` | `None` | +| `grant_context_permissions` | `ContextPermissions \| None` | `None` | **Returns:** `ContextToken` @@ -127,7 +127,7 @@ Add a Message or Artifact to the context history (append-only) | Name | Type | Default | |------|------|---------| | `data` | `Message \| Artifact` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -139,7 +139,7 @@ Delete all history items from a specific item onwards (inclusive) | Name | Type | Default | |------|------|---------| | `from_id` | `UUID \| str` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -150,11 +150,11 @@ List all history items for this context in chronological order | Name | Type | Default | |------|------|---------| -| `page_token` | `str \| None` | — | -| `limit` | `int \| None` | — | +| `page_token` | `str \| None` | `None` | +| `limit` | `int \| None` | `None` | | `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | -| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `PaginatedResult[ContextHistoryItem]` @@ -164,7 +164,7 @@ List all history items for this context in chronological order | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `AsyncIterator[ContextHistoryItem]` diff --git a/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx b/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx index 1463071797..6df030df8d 100644 --- a/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextHistoryItem.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / ContextHistoryItem +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Context](/development/reference/python-sdk/platform-context) / ContextHistoryItem ```py from agentstack_sdk.platform.context import ContextHistoryItem ``` diff --git a/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx b/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx index 7eaa60801f..fb32d757ea 100644 --- a/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextPermissions.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / ContextPermissions +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Context](/development/reference/python-sdk/platform-context) / ContextPermissions ```py from agentstack_sdk.platform.context import ContextPermissions ``` diff --git a/docs/development/reference/python-sdk/platform-context/ContextToken.mdx b/docs/development/reference/python-sdk/platform-context/ContextToken.mdx index a4aa9b69dd..b4162ed921 100644 --- a/docs/development/reference/python-sdk/platform-context/ContextToken.mdx +++ b/docs/development/reference/python-sdk/platform-context/ContextToken.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / ContextToken +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Context](/development/reference/python-sdk/platform-context) / ContextToken ```py from agentstack_sdk.platform.context import ContextToken ``` diff --git a/docs/development/reference/python-sdk/platform-context/Permissions.mdx b/docs/development/reference/python-sdk/platform-context/Permissions.mdx index 62d66a61bb..02866bdb43 100644 --- a/docs/development/reference/python-sdk/platform-context/Permissions.mdx +++ b/docs/development/reference/python-sdk/platform-context/Permissions.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform-new) / [Context](/development/reference/python-sdk/platform-context) / Permissions +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / [Context](/development/reference/python-sdk/platform-context) / Permissions ```py from agentstack_sdk.platform.context import Permissions ``` diff --git a/docs/development/reference/python-sdk/platform.mdx b/docs/development/reference/python-sdk/platform.mdx index 48633c66c7..3443593468 100644 --- a/docs/development/reference/python-sdk/platform.mdx +++ b/docs/development/reference/python-sdk/platform.mdx @@ -10,11 +10,20 @@ description: "Clients for files, vector stores, contexts, providers, and more" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / Platform ```py from agentstack_sdk.platform import PlatformClient, SystemConfiguration, AuthorizationCodeRequest # ... ``` +## Submodules + + + + Shared types and utilities + + + Context management + + --- ## Client diff --git a/docs/development/reference/python-sdk/platform/AddProvider.mdx b/docs/development/reference/python-sdk/platform/AddProvider.mdx index 50f3e03a44..88605fc0f4 100644 --- a/docs/development/reference/python-sdk/platform/AddProvider.mdx +++ b/docs/development/reference/python-sdk/platform/AddProvider.mdx @@ -10,7 +10,7 @@ description: "Will add a new provider or update an existing one with the same ba DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / AddProvider +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / AddProvider ```py from agentstack_sdk.platform import AddProvider ``` diff --git a/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx b/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx index 5583cfbadf..cefec4301b 100644 --- a/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx +++ b/docs/development/reference/python-sdk/platform/AuthorizationCodeRequest.mdx @@ -10,7 +10,7 @@ description: "Authorization request for code-based OAuth flow" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / AuthorizationCodeRequest +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / AuthorizationCodeRequest ```py from agentstack_sdk.platform import AuthorizationCodeRequest ``` diff --git a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx index 6a8b56c804..1edab77fa6 100644 --- a/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx +++ b/docs/development/reference/python-sdk/platform/BuildConfiguration.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / BuildConfiguration +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / BuildConfiguration ```py from agentstack_sdk.platform import BuildConfiguration ``` diff --git a/docs/development/reference/python-sdk/platform/BuildState.mdx b/docs/development/reference/python-sdk/platform/BuildState.mdx index 4859aa5b38..8d23f639c2 100644 --- a/docs/development/reference/python-sdk/platform/BuildState.mdx +++ b/docs/development/reference/python-sdk/platform/BuildState.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / BuildState +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / BuildState ```py from agentstack_sdk.platform import BuildState ``` diff --git a/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx b/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx index 7a90ea8ebe..fe77cb0561 100644 --- a/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx +++ b/docs/development/reference/python-sdk/platform/ChangeRoleResponse.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ChangeRoleResponse +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ChangeRoleResponse ```py from agentstack_sdk.platform import ChangeRoleResponse ``` diff --git a/docs/development/reference/python-sdk/platform/Connector.mdx b/docs/development/reference/python-sdk/platform/Connector.mdx index c08d102473..89e3329ef2 100644 --- a/docs/development/reference/python-sdk/platform/Connector.mdx +++ b/docs/development/reference/python-sdk/platform/Connector.mdx @@ -10,7 +10,7 @@ description: "Represents a configured connector instance" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Connector +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / Connector ```py from agentstack_sdk.platform import Connector ``` @@ -53,11 +53,11 @@ Returns: | Name | Type | Default | |------|------|---------| | `url` | `AnyUrl \| str` | — | -| `client_id` | `str \| None` | — | -| `client_secret` | `str \| None` | — | -| `metadata` | `Metadata \| None` | — | +| `client_id` | `str \| None` | `None` | +| `client_secret` | `str \| None` | `None` | +| `metadata` | `Metadata \| None` | `None` | | `match_preset` | `bool` | `True` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Connector'` @@ -71,7 +71,7 @@ Returns: | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `PaginatedResult['Connector']` @@ -82,7 +82,7 @@ Read a specific connector by ID. | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Connector'` @@ -96,7 +96,7 @@ Args: | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -107,7 +107,7 @@ This is just a syntactic sugar for calling Connector.get(). | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Connector'` @@ -134,7 +134,7 @@ Raises: |------|------|---------| | `state` | `ConnectorState` | `ConnectorState.connected` | | `poll_interval` | `int` | `1` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Connector'` @@ -145,7 +145,7 @@ Raises: | Name | Type | Default | |------|------|---------| | `poll_interval` | `int` | `1` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -167,9 +167,9 @@ Returns: | Name | Type | Default | |------|------|---------| -| `redirect_url` | `AnyUrl \| str \| None` | — | -| `access_token` | `str \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `redirect_url` | `AnyUrl \| str \| None` | `None` | +| `access_token` | `str \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Connector'` @@ -186,7 +186,7 @@ Returns: | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Connector'` @@ -211,9 +211,9 @@ Yields: | Name | Type | Default | |------|------|---------| | `method` | `str` | — | -| `headers` | `dict \| None` | — | -| `content` | `bytes \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `headers` | `dict \| None` | `None` | +| `content` | `bytes \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `AsyncIterator[MCPProxyResponse]` @@ -227,7 +227,7 @@ Returns: | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `PaginatedResult['ConnectorPreset']` diff --git a/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx b/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx index e59eadcc01..67989e4af1 100644 --- a/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx +++ b/docs/development/reference/python-sdk/platform/ConnectorPreset.mdx @@ -10,7 +10,7 @@ description: "Represents a preset connector configuration" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ConnectorPreset +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ConnectorPreset ```py from agentstack_sdk.platform import ConnectorPreset ``` diff --git a/docs/development/reference/python-sdk/platform/ConnectorState.mdx b/docs/development/reference/python-sdk/platform/ConnectorState.mdx index 9f975dd2af..8e65c456ec 100644 --- a/docs/development/reference/python-sdk/platform/ConnectorState.mdx +++ b/docs/development/reference/python-sdk/platform/ConnectorState.mdx @@ -10,7 +10,7 @@ description: "Enumeration of possible connector states" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ConnectorState +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ConnectorState ```py from agentstack_sdk.platform import ConnectorState ``` diff --git a/docs/development/reference/python-sdk/platform/DiscoveryState.mdx b/docs/development/reference/python-sdk/platform/DiscoveryState.mdx index 88e26ade13..b45342f89b 100644 --- a/docs/development/reference/python-sdk/platform/DiscoveryState.mdx +++ b/docs/development/reference/python-sdk/platform/DiscoveryState.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / DiscoveryState +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / DiscoveryState ```py from agentstack_sdk.platform import DiscoveryState ``` diff --git a/docs/development/reference/python-sdk/platform/EnvVar.mdx b/docs/development/reference/python-sdk/platform/EnvVar.mdx index 22e6c575d2..c95a5a2ee0 100644 --- a/docs/development/reference/python-sdk/platform/EnvVar.mdx +++ b/docs/development/reference/python-sdk/platform/EnvVar.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / EnvVar +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / EnvVar ```py from agentstack_sdk.platform import EnvVar ``` diff --git a/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx b/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx index daf37cfe91..f1e6675050 100644 --- a/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx +++ b/docs/development/reference/python-sdk/platform/ExtractedFileInfo.mdx @@ -10,7 +10,7 @@ description: "Information about an extracted file" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ExtractedFileInfo +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ExtractedFileInfo ```py from agentstack_sdk.platform import ExtractedFileInfo ``` diff --git a/docs/development/reference/python-sdk/platform/Extraction.mdx b/docs/development/reference/python-sdk/platform/Extraction.mdx index e8e9fa39c7..c044a5c9f6 100644 --- a/docs/development/reference/python-sdk/platform/Extraction.mdx +++ b/docs/development/reference/python-sdk/platform/Extraction.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Extraction +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / Extraction ```py from agentstack_sdk.platform import Extraction ``` diff --git a/docs/development/reference/python-sdk/platform/File.mdx b/docs/development/reference/python-sdk/platform/File.mdx index 44789215a2..bc8d0fef2a 100644 --- a/docs/development/reference/python-sdk/platform/File.mdx +++ b/docs/development/reference/python-sdk/platform/File.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / File +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / File ```py from agentstack_sdk.platform import File ``` @@ -43,7 +43,7 @@ from agentstack_sdk.platform import File | `filename` | `str` | — | | `content` | `BinaryIO \| bytes` | — | | `content_type` | `str` | `'application/octet-stream'` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `'File'` @@ -54,7 +54,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `'File'` @@ -65,7 +65,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `None` @@ -77,7 +77,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| | `stream` | `bool` | `False` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `AsyncIterator[LoadedFile]` @@ -89,7 +89,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| | `stream` | `bool` | `False` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `AsyncIterator[LoadedFile]` @@ -101,7 +101,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| | `stream` | `bool` | `False` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `AsyncIterator[LoadedFile]` @@ -112,8 +112,8 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| -| `formats` | `builtins.list[ExtractionFormatLiteral] \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `formats` | `builtins.list[ExtractionFormatLiteral] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `Extraction` @@ -124,7 +124,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `Extraction` @@ -135,7 +135,7 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `None` @@ -150,13 +150,13 @@ from agentstack_sdk.platform import File | Name | Type | Default | |------|------|---------| -| `content_type` | `str \| None` | — | -| `filename_search` | `str \| None` | — | -| `page_token` | `str \| None` | — | -| `limit` | `int \| None` | — | +| `content_type` | `str \| None` | `None` | +| `filename_search` | `str \| None` | `None` | +| `page_token` | `str \| None` | `None` | +| `limit` | `int \| None` | `None` | | `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | -| `order_by` | `Literal['created_at'] \| Literal['filename'] \| Literal['file_size_bytes'] \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `order_by` | `Literal['created_at'] \| Literal['filename'] \| Literal['file_size_bytes'] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `PaginatedResult['File']` diff --git a/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx b/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx index 29b8d7b9cc..8d8d370be1 100644 --- a/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx +++ b/docs/development/reference/python-sdk/platform/ListUserFeedbackResponse.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ListUserFeedbackResponse +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ListUserFeedbackResponse ```py from agentstack_sdk.platform import ListUserFeedbackResponse ``` diff --git a/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx b/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx index 0048fd0847..5ad418adcd 100644 --- a/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx +++ b/docs/development/reference/python-sdk/platform/MCPProxyResponse.mdx @@ -10,7 +10,7 @@ description: "Response from an MCP proxy request with headers and streaming cont DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / MCPProxyResponse +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / MCPProxyResponse ```py from agentstack_sdk.platform import MCPProxyResponse ``` diff --git a/docs/development/reference/python-sdk/platform/ModelCapability.mdx b/docs/development/reference/python-sdk/platform/ModelCapability.mdx index 6cd7e3580e..61d86fdfab 100644 --- a/docs/development/reference/python-sdk/platform/ModelCapability.mdx +++ b/docs/development/reference/python-sdk/platform/ModelCapability.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelCapability +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ModelCapability ```py from agentstack_sdk.platform import ModelCapability ``` diff --git a/docs/development/reference/python-sdk/platform/ModelProvider.mdx b/docs/development/reference/python-sdk/platform/ModelProvider.mdx index e21f6ee4b7..d15c389c3f 100644 --- a/docs/development/reference/python-sdk/platform/ModelProvider.mdx +++ b/docs/development/reference/python-sdk/platform/ModelProvider.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelProvider +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ModelProvider ```py from agentstack_sdk.platform import ModelProvider ``` @@ -41,14 +41,14 @@ from agentstack_sdk.platform import ModelProvider | Name | Type | Default | |------|------|---------| -| `name` | `str \| None` | — | -| `description` | `str \| None` | — | +| `name` | `str \| None` | `None` | +| `description` | `str \| None` | `None` | | `type` | `ModelProviderType` | — | | `base_url` | `str \| pydantic.HttpUrl` | — | -| `watsonx_project_id` | `str \| None` | — | -| `watsonx_space_id` | `str \| None` | — | +| `watsonx_project_id` | `str \| None` | `None` | +| `watsonx_space_id` | `str \| None` | `None` | | `api_key` | `str` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'ModelProvider'` @@ -58,7 +58,7 @@ from agentstack_sdk.platform import ModelProvider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'ModelProvider'` @@ -68,7 +68,7 @@ from agentstack_sdk.platform import ModelProvider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -79,8 +79,8 @@ from agentstack_sdk.platform import ModelProvider | Name | Type | Default | |------|------|---------| | `capability` | `ModelCapability` | `ModelCapability.LLM` | -| `suggested_models` | `tuple[str, ...] \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `suggested_models` | `tuple[str, ...] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `builtins.list[ModelWithScore]` @@ -90,7 +90,7 @@ from agentstack_sdk.platform import ModelProvider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `builtins.list['ModelProvider']` diff --git a/docs/development/reference/python-sdk/platform/ModelProviderState.mdx b/docs/development/reference/python-sdk/platform/ModelProviderState.mdx index 44a52cc8e8..dd8123cbb7 100644 --- a/docs/development/reference/python-sdk/platform/ModelProviderState.mdx +++ b/docs/development/reference/python-sdk/platform/ModelProviderState.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelProviderState +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ModelProviderState ```py from agentstack_sdk.platform import ModelProviderState ``` diff --git a/docs/development/reference/python-sdk/platform/ModelProviderType.mdx b/docs/development/reference/python-sdk/platform/ModelProviderType.mdx index b187050453..a0696f09d8 100644 --- a/docs/development/reference/python-sdk/platform/ModelProviderType.mdx +++ b/docs/development/reference/python-sdk/platform/ModelProviderType.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelProviderType +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ModelProviderType ```py from agentstack_sdk.platform import ModelProviderType ``` diff --git a/docs/development/reference/python-sdk/platform/ModelWithScore.mdx b/docs/development/reference/python-sdk/platform/ModelWithScore.mdx index 4a2e99fdb0..03f8397f01 100644 --- a/docs/development/reference/python-sdk/platform/ModelWithScore.mdx +++ b/docs/development/reference/python-sdk/platform/ModelWithScore.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ModelWithScore +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ModelWithScore ```py from agentstack_sdk.platform import ModelWithScore ``` diff --git a/docs/development/reference/python-sdk/platform/NoAction.mdx b/docs/development/reference/python-sdk/platform/NoAction.mdx index 6d9b3a3f1f..54fd0d77bd 100644 --- a/docs/development/reference/python-sdk/platform/NoAction.mdx +++ b/docs/development/reference/python-sdk/platform/NoAction.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / NoAction +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / NoAction ```py from agentstack_sdk.platform import NoAction ``` diff --git a/docs/development/reference/python-sdk/platform/PlatformClient.mdx b/docs/development/reference/python-sdk/platform/PlatformClient.mdx index aba4f6394c..0720a12186 100644 --- a/docs/development/reference/python-sdk/platform/PlatformClient.mdx +++ b/docs/development/reference/python-sdk/platform/PlatformClient.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / PlatformClient +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / PlatformClient ```py from agentstack_sdk.platform import PlatformClient ``` @@ -30,25 +30,25 @@ from agentstack_sdk.platform import PlatformClient | Name | Type | Default | |------|------|---------| -| `context_id` | `str \| None` | — | -| `auth_token` | `str \| Secret[str] \| None` | — | -| `auth` | `AuthTypes \| None` | — | -| `params` | `QueryParamTypes \| None` | — | -| `headers` | `HeaderTypes \| None` | — | -| `cookies` | `CookieTypes \| None` | — | +| `context_id` | `str \| None` | `None` | +| `auth_token` | `str \| Secret[str] \| None` | `None` | +| `auth` | `AuthTypes \| None` | `None` | +| `params` | `QueryParamTypes \| None` | `None` | +| `headers` | `HeaderTypes \| None` | `None` | +| `cookies` | `CookieTypes \| None` | `None` | | `verify` | `SSLContext \| str \| bool` | `True` | -| `cert` | `CertTypes \| None` | — | +| `cert` | `CertTypes \| None` | `None` | | `http1` | `bool` | `True` | | `http2` | `bool` | `False` | -| `proxy` | `ProxyTypes \| None` | — | -| `mounts` | `None \| Mapping[str, AsyncBaseTransport \| None]` | — | +| `proxy` | `ProxyTypes \| None` | `None` | +| `mounts` | `None \| Mapping[str, AsyncBaseTransport \| None]` | `None` | | `timeout` | `TimeoutTypes` | `DEFAULT_SDK_TIMEOUT` | | `follow_redirects` | `bool` | `False` | | `limits` | `Limits` | `DEFAULT_LIMITS` | | `max_redirects` | `int` | `DEFAULT_MAX_REDIRECTS` | -| `event_hooks` | `None \| Mapping[str, list[EventHook]]` | — | +| `event_hooks` | `None \| Mapping[str, list[EventHook]]` | `None` | | `base_url` | `URL \| str` | `''` | -| `transport` | `AsyncBaseTransport \| None` | — | +| `transport` | `AsyncBaseTransport \| None` | `None` | | `trust_env` | `bool` | `True` | | `default_encoding` | `str \| typing.Callable[[bytes], str]` | `'utf-8'` | diff --git a/docs/development/reference/python-sdk/platform/Provider.mdx b/docs/development/reference/python-sdk/platform/Provider.mdx index 7bd0f148c9..8000cc631e 100644 --- a/docs/development/reference/python-sdk/platform/Provider.mdx +++ b/docs/development/reference/python-sdk/platform/Provider.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Provider +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / Provider ```py from agentstack_sdk.platform import Provider ``` @@ -47,11 +47,11 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| | `location` | `str` | — | -| `agent_card` | `AgentCard \| None` | — | -| `origin` | `str \| None` | — | -| `auto_stop_timeout` | `timedelta \| None` | — | -| `variables` | `dict[str, str] \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `agent_card` | `AgentCard \| None` | `None` | +| `origin` | `str \| None` | `None` | +| `auto_stop_timeout` | `timedelta \| None` | `None` | +| `variables` | `dict[str, str] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Provider'` @@ -61,12 +61,12 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `location` | `str \| None` | — | -| `agent_card` | `AgentCard \| None` | — | -| `origin` | `str \| None` | — | -| `auto_stop_timeout` | `timedelta \| None` | — | -| `variables` | `dict[str, str] \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `location` | `str \| None` | `None` | +| `agent_card` | `AgentCard \| None` | `None` | +| `origin` | `str \| None` | `None` | +| `auto_stop_timeout` | `timedelta \| None` | `None` | +| `variables` | `dict[str, str] \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Provider'` @@ -76,7 +76,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Parameters** @@ -84,8 +84,8 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| | `location` | `str` | — | -| `agent_card` | `AgentCard \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `agent_card` | `AgentCard \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Provider'` @@ -95,7 +95,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Provider'` @@ -106,7 +106,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| | `location` | `str` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Provider'` @@ -116,7 +116,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -127,7 +127,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| | `variables` | `dict[str, str \| None] \| dict[str, str]` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -137,7 +137,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `AsyncIterator[dict[str, typing.Any]]` @@ -147,7 +147,7 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `dict[str, str]` @@ -157,9 +157,9 @@ from agentstack_sdk.platform import Provider | Name | Type | Default | |------|------|---------| -| `origin` | `str \| None` | — | -| `user_owned` | `bool \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `origin` | `str \| None` | `None` | +| `user_owned` | `bool \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `builtins.list['Provider']` diff --git a/docs/development/reference/python-sdk/platform/ProviderBuild.mdx b/docs/development/reference/python-sdk/platform/ProviderBuild.mdx index 14b667db9c..73f1719480 100644 --- a/docs/development/reference/python-sdk/platform/ProviderBuild.mdx +++ b/docs/development/reference/python-sdk/platform/ProviderBuild.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ProviderBuild +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ProviderBuild ```py from agentstack_sdk.platform import ProviderBuild ``` @@ -42,9 +42,9 @@ from agentstack_sdk.platform import ProviderBuild | Name | Type | Default | |------|------|---------| | `location` | `str` | — | -| `client` | `PlatformClient \| None` | — | -| `on_complete` | `OnCompleteAction \| None` | — | -| `build_configuration` | `BuildConfiguration \| None` | — | +| `client` | `PlatformClient \| None` | `None` | +| `on_complete` | `OnCompleteAction \| None` | `None` | +| `build_configuration` | `BuildConfiguration \| None` | `None` | **Returns:** `'ProviderBuild'` @@ -55,8 +55,8 @@ from agentstack_sdk.platform import ProviderBuild | Name | Type | Default | |------|------|---------| | `location` | `str` | — | -| `client` | `PlatformClient \| None` | — | -| `on_complete` | `OnCompleteAction \| None` | — | +| `client` | `PlatformClient \| None` | `None` | +| `on_complete` | `OnCompleteAction \| None` | `None` | **Returns:** `'ProviderBuild'` @@ -66,7 +66,7 @@ from agentstack_sdk.platform import ProviderBuild | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `AsyncIterator[dict[str, Any]]` @@ -76,7 +76,7 @@ from agentstack_sdk.platform import ProviderBuild | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'ProviderBuild'` @@ -86,7 +86,7 @@ from agentstack_sdk.platform import ProviderBuild | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -96,12 +96,12 @@ from agentstack_sdk.platform import ProviderBuild | Name | Type | Default | |------|------|---------| -| `page_token` | `str \| None` | — | -| `limit` | `int \| None` | — | +| `page_token` | `str \| None` | `None` | +| `limit` | `int \| None` | `None` | | `order` | `Literal['asc'] \| Literal['desc'] \| None` | `'asc'` | -| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | — | -| `user_owned` | `bool \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `order_by` | `Literal['created_at'] \| Literal['updated_at'] \| None` | `None` | +| `user_owned` | `bool \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `PaginatedResult['ProviderBuild']` diff --git a/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx b/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx index 5c29033686..85c63bfe92 100644 --- a/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx +++ b/docs/development/reference/python-sdk/platform/ProviderDiscovery.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ProviderDiscovery +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ProviderDiscovery ```py from agentstack_sdk.platform import ProviderDiscovery ``` @@ -39,7 +39,7 @@ from agentstack_sdk.platform import ProviderDiscovery | Name | Type | Default | |------|------|---------| | `docker_image` | `str` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'ProviderDiscovery'` @@ -49,7 +49,7 @@ from agentstack_sdk.platform import ProviderDiscovery | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'ProviderDiscovery'` diff --git a/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx b/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx index 64c939a1a1..2d03c5dbf4 100644 --- a/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx +++ b/docs/development/reference/python-sdk/platform/ProviderErrorMessage.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / ProviderErrorMessage +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / ProviderErrorMessage ```py from agentstack_sdk.platform import ProviderErrorMessage ``` diff --git a/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx b/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx index 1d40211930..0c708e787c 100644 --- a/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx +++ b/docs/development/reference/python-sdk/platform/SystemConfiguration.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / SystemConfiguration +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / SystemConfiguration ```py from agentstack_sdk.platform import SystemConfiguration ``` @@ -37,7 +37,7 @@ Get the current system configuration. | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'SystemConfiguration'` @@ -48,9 +48,9 @@ Update the system configuration. | Name | Type | Default | |------|------|---------| -| `default_llm_model` | `str \| None` | — | -| `default_embedding_model` | `str \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `default_llm_model` | `str \| None` | `None` | +| `default_embedding_model` | `str \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'SystemConfiguration'` diff --git a/docs/development/reference/python-sdk/platform/UpdateProvider.mdx b/docs/development/reference/python-sdk/platform/UpdateProvider.mdx index 15990085ea..f7196ea897 100644 --- a/docs/development/reference/python-sdk/platform/UpdateProvider.mdx +++ b/docs/development/reference/python-sdk/platform/UpdateProvider.mdx @@ -10,7 +10,7 @@ description: "Will update provider specified by ID" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / UpdateProvider +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / UpdateProvider ```py from agentstack_sdk.platform import UpdateProvider ``` diff --git a/docs/development/reference/python-sdk/platform/User.mdx b/docs/development/reference/python-sdk/platform/User.mdx index 785ff3a1ce..fd4e64aa93 100644 --- a/docs/development/reference/python-sdk/platform/User.mdx +++ b/docs/development/reference/python-sdk/platform/User.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / User +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / User ```py from agentstack_sdk.platform import User ``` @@ -35,7 +35,7 @@ from agentstack_sdk.platform import User | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'User'` @@ -45,10 +45,10 @@ from agentstack_sdk.platform import User | Name | Type | Default | |------|------|---------| -| `email` | `str \| None` | — | +| `email` | `str \| None` | `None` | | `limit` | `int` | `40` | -| `page_token` | `str \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `page_token` | `str \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `PaginatedResult['User']` @@ -60,7 +60,7 @@ from agentstack_sdk.platform import User |------|------|---------| | `user_id` | `str` | — | | `new_role` | `UserRole` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `ChangeRoleResponse` diff --git a/docs/development/reference/python-sdk/platform/UserFeedback.mdx b/docs/development/reference/python-sdk/platform/UserFeedback.mdx index 7a7f2434d7..9af85fdad6 100644 --- a/docs/development/reference/python-sdk/platform/UserFeedback.mdx +++ b/docs/development/reference/python-sdk/platform/UserFeedback.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / UserFeedback +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / UserFeedback ```py from agentstack_sdk.platform import UserFeedback ``` @@ -41,10 +41,10 @@ from agentstack_sdk.platform import UserFeedback | Name | Type | Default | |------|------|---------| -| `provider_id` | `str \| None` | — | +| `provider_id` | `str \| None` | `None` | | `limit` | `int` | `50` | -| `after_cursor` | `str \| None` | — | -| `client` | `PlatformClient \| None` | — | +| `after_cursor` | `str \| None` | `None` | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'ListUserFeedbackResponse'` diff --git a/docs/development/reference/python-sdk/platform/UserRole.mdx b/docs/development/reference/python-sdk/platform/UserRole.mdx index edcb0826a4..9b7dbaf7da 100644 --- a/docs/development/reference/python-sdk/platform/UserRole.mdx +++ b/docs/development/reference/python-sdk/platform/UserRole.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / UserRole +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / UserRole ```py from agentstack_sdk.platform import UserRole ``` diff --git a/docs/development/reference/python-sdk/platform/Variables.mdx b/docs/development/reference/python-sdk/platform/Variables.mdx index 4c141bf32e..37e7ae2cdd 100644 --- a/docs/development/reference/python-sdk/platform/Variables.mdx +++ b/docs/development/reference/python-sdk/platform/Variables.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / Variables +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / Variables ```py from agentstack_sdk.platform import Variables ``` @@ -30,7 +30,7 @@ Can be used as a class method: Variables.save(\{"key": "value", ...\}) | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `None` @@ -44,7 +44,7 @@ Can be used as a class method: variables = Variables.load() | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | **Returns:** `'Variables'` diff --git a/docs/development/reference/python-sdk/platform/VectorStore.mdx b/docs/development/reference/python-sdk/platform/VectorStore.mdx index 7341c03a7d..ab263319f6 100644 --- a/docs/development/reference/python-sdk/platform/VectorStore.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStore.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStore +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / VectorStore ```py from agentstack_sdk.platform import VectorStore ``` @@ -42,7 +42,7 @@ from agentstack_sdk.platform import VectorStore | `name` | `str` | — | | `dimension` | `int` | — | | `model_id` | `str` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `'VectorStore'` @@ -53,7 +53,7 @@ from agentstack_sdk.platform import VectorStore | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `'VectorStore'` @@ -64,7 +64,7 @@ from agentstack_sdk.platform import VectorStore | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `None` @@ -76,7 +76,7 @@ from agentstack_sdk.platform import VectorStore | Name | Type | Default | |------|------|---------| | `items` | `list[VectorStoreItem]` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `None` @@ -89,7 +89,7 @@ from agentstack_sdk.platform import VectorStore |------|------|---------| | `query_vector` | `list[float]` | — | | `limit` | `int` | `10` | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `list[VectorStoreSearchResult]` @@ -100,7 +100,7 @@ from agentstack_sdk.platform import VectorStore | Name | Type | Default | |------|------|---------| -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `list[VectorStoreDocument]` @@ -112,7 +112,7 @@ from agentstack_sdk.platform import VectorStore | Name | Type | Default | |------|------|---------| | `document_id` | `str` | — | -| `client` | `PlatformClient \| None` | — | +| `client` | `PlatformClient \| None` | `None` | | `context_id` | `str \| None \| Literal['auto']` | `'auto'` | **Returns:** `None` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx b/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx index ead4940b3f..56ef6c878b 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreDocument.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreDocument +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / VectorStoreDocument ```py from agentstack_sdk.platform import VectorStoreDocument ``` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx b/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx index 1c28ad9f41..43514db28b 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreItem.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreItem +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / VectorStoreItem ```py from agentstack_sdk.platform import VectorStoreItem ``` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx b/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx index 1b2b8e8d30..d18c68b8ac 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreSearchResult.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreSearchResult +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / VectorStoreSearchResult ```py from agentstack_sdk.platform import VectorStoreSearchResult ``` diff --git a/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx b/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx index c0660f0426..652bf74471 100644 --- a/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx +++ b/docs/development/reference/python-sdk/platform/VectorStoreStats.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VectorStoreStats +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / VectorStoreStats ```py from agentstack_sdk.platform import VectorStoreStats ``` diff --git a/docs/development/reference/python-sdk/platform/VersionInfo.mdx b/docs/development/reference/python-sdk/platform/VersionInfo.mdx index df837ed17b..60423bc178 100644 --- a/docs/development/reference/python-sdk/platform/VersionInfo.mdx +++ b/docs/development/reference/python-sdk/platform/VersionInfo.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / VersionInfo +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / VersionInfo ```py from agentstack_sdk.platform import VersionInfo ``` diff --git a/docs/development/reference/python-sdk/platform/get_platform_client.mdx b/docs/development/reference/python-sdk/platform/get_platform_client.mdx index 71f1790884..c3d116a510 100644 --- a/docs/development/reference/python-sdk/platform/get_platform_client.mdx +++ b/docs/development/reference/python-sdk/platform/get_platform_client.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / get_platform_client +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / get_platform_client ```py from agentstack_sdk.platform import get_platform_client ``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/set_platform_client.mdx b/docs/development/reference/python-sdk/platform/set_platform_client.mdx index 005fe3a73d..a23cd35a82 100644 --- a/docs/development/reference/python-sdk/platform/set_platform_client.mdx +++ b/docs/development/reference/python-sdk/platform/set_platform_client.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / set_platform_client +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / set_platform_client ```py from agentstack_sdk.platform import set_platform_client ``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/use_platform_client.mdx b/docs/development/reference/python-sdk/platform/use_platform_client.mdx index 4a8bf57bf7..4ebdb8cefa 100644 --- a/docs/development/reference/python-sdk/platform/use_platform_client.mdx +++ b/docs/development/reference/python-sdk/platform/use_platform_client.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / use_platform_client +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / use_platform_client ```py from agentstack_sdk.platform import use_platform_client ``` \ No newline at end of file diff --git a/docs/development/reference/python-sdk/platform/uuid_to_str.mdx b/docs/development/reference/python-sdk/platform/uuid_to_str.mdx index 3a4196cf85..65751f6685 100644 --- a/docs/development/reference/python-sdk/platform/uuid_to_str.mdx +++ b/docs/development/reference/python-sdk/platform/uuid_to_str.mdx @@ -10,7 +10,7 @@ description: "Convert UUID or str to str" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / uuid_to_str +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / uuid_to_str ```py from agentstack_sdk.platform import uuid_to_str ``` diff --git a/docs/development/reference/python-sdk/platform/validate_metadata.mdx b/docs/development/reference/python-sdk/platform/validate_metadata.mdx index 18df7ca026..4f8bce17a0 100644 --- a/docs/development/reference/python-sdk/platform/validate_metadata.mdx +++ b/docs/development/reference/python-sdk/platform/validate_metadata.mdx @@ -10,7 +10,7 @@ description: "" DO NOT EDIT THIS FILE BY HAND, IT IS AUTOMATICALLY GENERATED BY `mise agentstack-sdk-py:docs` */} -[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform API Overview](/development/reference/python-sdk/platform-idx) / [Platform](/development/reference/python-sdk/platform) / validate_metadata +[Python SDK Reference](/development/reference/python-sdk/overview) / [Platform](/development/reference/python-sdk/platform) / validate_metadata ```py from agentstack_sdk.platform import validate_metadata ``` diff --git a/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx index fc6fb9a7f5..2a1daf0d37 100644 --- a/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx +++ b/docs/development/reference/python-sdk/server-middleware-platform-auth-backend/PlatformAuthBackend.mdx @@ -31,8 +31,8 @@ from agentstack_sdk.server.middleware.platform_auth_backend import PlatformAuthB | Name | Type | Default | |------|------|---------| -| `public_url` | `str \| None` | — | -| `skip_audience_validation` | `bool \| None` | — | +| `public_url` | `str \| None` | `None` | +| `skip_audience_validation` | `bool \| None` | `None` | **Returns:** `None` diff --git a/docs/development/reference/python-sdk/server/AgentRun.mdx b/docs/development/reference/python-sdk/server/AgentRun.mdx index 9e45ae5f3b..fb26872b23 100644 --- a/docs/development/reference/python-sdk/server/AgentRun.mdx +++ b/docs/development/reference/python-sdk/server/AgentRun.mdx @@ -36,7 +36,7 @@ from agentstack_sdk.server import AgentRun |------|------|---------| | `agent` | `Agent` | — | | `context_store` | `ContextStore` | — | -| `on_finish` | `Callable[[], None] \| None` | — | +| `on_finish` | `Callable[[], None] \| None` | `None` | **Returns:** `None` diff --git a/docs/development/reference/python-sdk/server/Server.mdx b/docs/development/reference/python-sdk/server/Server.mdx index 23cddfe9ff..6013f687af 100644 --- a/docs/development/reference/python-sdk/server/Server.mdx +++ b/docs/development/reference/python-sdk/server/Server.mdx @@ -50,19 +50,19 @@ from agentstack_sdk.server import Server | `configure_logger` | `bool` | `True` | | `configure_telemetry` | `bool` | `False` | | `self_registration` | `bool` | `True` | -| `self_registration_id` | `str \| None` | — | -| `task_store` | `TaskStore \| None` | — | -| `context_store` | `ContextStore \| None` | — | -| `queue_manager` | `QueueManager \| None` | — | +| `self_registration_id` | `str \| None` | `None` | +| `task_store` | `TaskStore \| None` | `None` | +| `context_store` | `ContextStore \| None` | `None` | +| `queue_manager` | `QueueManager \| None` | `None` | | `task_timeout` | `timedelta` | `timedelta(minutes=10)` | -| `push_config_store` | `PushNotificationConfigStore \| None` | — | -| `push_sender` | `PushNotificationSender \| None` | — | -| `request_context_builder` | `RequestContextBuilder \| None` | — | +| `push_config_store` | `PushNotificationConfigStore \| None` | `None` | +| `push_sender` | `PushNotificationSender \| None` | `None` | +| `request_context_builder` | `RequestContextBuilder \| None` | `None` | | `host` | `str` | `'127.0.0.1'` | | `port` | `int` | `10000` | -| `url` | `str \| None` | — | -| `uds` | `str \| None` | — | -| `fd` | `int \| None` | — | +| `url` | `str \| None` | `None` | +| `uds` | `str \| None` | `None` | +| `fd` | `int \| None` | `None` | | `loop` | `Literal['none', 'auto', 'asyncio', 'uvloop']` | `'auto'` | | `http` | `type[asyncio.Protocol] \| uvicorn_config.HTTPProtocolType` | `'auto'` | | `ws` | `type[asyncio.Protocol] \| uvicorn_config.WSProtocolType` | `'auto'` | @@ -72,44 +72,44 @@ from agentstack_sdk.server import Server | `ws_ping_timeout` | `float \| None` | `20.0` | | `ws_per_message_deflate` | `bool` | `True` | | `lifespan` | `uvicorn_config.LifespanType` | `'auto'` | -| `lifespan_fn` | `Lifespan[AppType] \| None` | — | -| `env_file` | `str \| os.PathLike[str] \| None` | — | +| `lifespan_fn` | `Lifespan[AppType] \| None` | `None` | +| `env_file` | `str \| os.PathLike[str] \| None` | `None` | | `log_config` | `dict[str, Any] \| str \| RawConfigParser \| IO[Any] \| None` | `uvicorn_config.LOGGING_CONFIG` | -| `log_level` | `str \| int \| None` | — | +| `log_level` | `str \| int \| None` | `None` | | `access_log` | `bool` | `True` | -| `use_colors` | `bool \| None` | — | +| `use_colors` | `bool \| None` | `None` | | `interface` | `uvicorn_config.InterfaceType` | `'auto'` | | `reload` | `bool` | `False` | -| `reload_dirs` | `list[str] \| str \| None` | — | +| `reload_dirs` | `list[str] \| str \| None` | `None` | | `reload_delay` | `float` | `0.25` | -| `reload_includes` | `list[str] \| str \| None` | — | -| `reload_excludes` | `list[str] \| str \| None` | — | -| `workers` | `int \| None` | — | +| `reload_includes` | `list[str] \| str \| None` | `None` | +| `reload_excludes` | `list[str] \| str \| None` | `None` | +| `workers` | `int \| None` | `None` | | `proxy_headers` | `bool` | `True` | | `server_header` | `bool` | `True` | | `date_header` | `bool` | `True` | -| `forwarded_allow_ips` | `list[str] \| str \| None` | — | +| `forwarded_allow_ips` | `list[str] \| str \| None` | `None` | | `root_path` | `str` | `''` | -| `limit_concurrency` | `int \| None` | — | -| `limit_max_requests` | `int \| None` | — | +| `limit_concurrency` | `int \| None` | `None` | +| `limit_max_requests` | `int \| None` | `None` | | `backlog` | `int` | `2048` | | `timeout_keep_alive` | `int` | `5` | | `timeout_notify` | `int` | `30` | | `timeout_worker_healthcheck` | `int` | `5` | -| `timeout_graceful_shutdown` | `int \| None` | — | -| `callback_notify` | `Callable[..., Awaitable[None]] \| None` | — | -| `ssl_keyfile` | `str \| os.PathLike[str] \| None` | — | -| `ssl_certfile` | `str \| os.PathLike[str] \| None` | — | -| `ssl_keyfile_password` | `str \| None` | — | +| `timeout_graceful_shutdown` | `int \| None` | `None` | +| `callback_notify` | `Callable[..., Awaitable[None]] \| None` | `None` | +| `ssl_keyfile` | `str \| os.PathLike[str] \| None` | `None` | +| `ssl_certfile` | `str \| os.PathLike[str] \| None` | `None` | +| `ssl_keyfile_password` | `str \| None` | `None` | | `ssl_version` | `int` | `uvicorn_config.SSL_PROTOCOL_VERSION` | | `ssl_cert_reqs` | `int` | `CERT_NONE` | -| `ssl_ca_certs` | `str \| None` | — | +| `ssl_ca_certs` | `str \| None` | `None` | | `ssl_ciphers` | `str` | `'TLSv1'` | -| `headers` | `list[tuple[str, str]] \| None` | — | +| `headers` | `list[tuple[str, str]] \| None` | `None` | | `factory` | `bool` | `False` | -| `h11_max_incomplete_event_size` | `int \| None` | — | -| `self_registration_client_factory` | `Callable[[], PlatformClient] \| None` | — | -| `auth_backend` | `SdkAuthenticationBackend \| None` | — | +| `h11_max_incomplete_event_size` | `int \| None` | `None` | +| `self_registration_client_factory` | `Callable[[], PlatformClient] \| None` | `None` | +| `auth_backend` | `SdkAuthenticationBackend \| None` | `None` | **Returns:** `None` diff --git a/docs/development/reference/python-sdk/util/LoadedFile.mdx b/docs/development/reference/python-sdk/util/LoadedFile.mdx index 5d81e42a9e..68723c6746 100644 --- a/docs/development/reference/python-sdk/util/LoadedFile.mdx +++ b/docs/development/reference/python-sdk/util/LoadedFile.mdx @@ -43,7 +43,7 @@ This allows us to handle gzip, deflate, brotli, and zstd encoded responses. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `Iterator[bytes]` @@ -56,7 +56,7 @@ string encoding. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `Iterator[str]` @@ -76,7 +76,7 @@ This allows us to handle gzip, deflate, brotli, and zstd encoded responses. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `AsyncIterator[bytes]` @@ -89,7 +89,7 @@ string encoding. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `AsyncIterator[str]` diff --git a/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx b/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx index f8fac34279..acfdc8795e 100644 --- a/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx +++ b/docs/development/reference/python-sdk/util/LoadedFileWithBytes.mdx @@ -35,9 +35,9 @@ from agentstack_sdk.util import LoadedFileWithBytes | Name | Type | Default | |------|------|---------| | `content` | `bytes` | — | -| `filename` | `str \| None` | — | -| `content_type` | `str \| None` | — | -| `encoding` | `str \| None` | — | +| `filename` | `str \| None` | `None` | +| `content_type` | `str \| None` | `None` | +| `encoding` | `str \| None` | `None` | @@ -50,7 +50,7 @@ from agentstack_sdk.util import LoadedFileWithBytes | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `Iterator[bytes]` @@ -60,7 +60,7 @@ from agentstack_sdk.util import LoadedFileWithBytes | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `Iterator[str]` @@ -78,7 +78,7 @@ from agentstack_sdk.util import LoadedFileWithBytes | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `AsyncIterator[bytes]` @@ -88,7 +88,7 @@ from agentstack_sdk.util import LoadedFileWithBytes | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `AsyncIterator[str]` diff --git a/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx b/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx index 705faa30c8..b5afd6cd7a 100644 --- a/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx +++ b/docs/development/reference/python-sdk/util/LoadedFileWithUri.mdx @@ -34,9 +34,9 @@ from agentstack_sdk.util import LoadedFileWithUri | Name | Type | Default | |------|------|---------| | `response` | `Response` | — | -| `filename` | `str \| None` | — | -| `content_type` | `str \| None` | — | -| `file_size_bytes` | `int \| None` | — | +| `filename` | `str \| None` | `None` | +| `content_type` | `str \| None` | `None` | +| `file_size_bytes` | `int \| None` | `None` | @@ -52,7 +52,7 @@ This allows us to handle gzip, deflate, brotli, and zstd encoded responses. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `Iterator[bytes]` @@ -65,7 +65,7 @@ string encoding. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `Iterator[str]` @@ -86,7 +86,7 @@ This allows us to handle gzip, deflate, brotli, and zstd encoded responses. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `AsyncIterator[bytes]` @@ -99,7 +99,7 @@ string encoding. | Name | Type | Default | |------|------|---------| -| `chunk_size` | `int \| None` | — | +| `chunk_size` | `int \| None` | `None` | **Returns:** `AsyncIterator[str]` diff --git a/docs/docs.json b/docs/docs.json index 004463ca70..01fb48932d 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -163,7 +163,7 @@ } ] }, - "development/reference/python-sdk/platform-new", + "development/reference/python-sdk/platform", "development/reference/python-sdk/types", "development/reference/python-sdk/util" ] From 4bc4733c79aa578efdfffbe74ec1f62060f5de5d Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Wed, 4 Mar 2026 14:58:04 +0100 Subject: [PATCH 7/8] CR changes Signed-off-by: Jan Jeliga --- CONTRIBUTING.md | 2 - apps/agentstack-sdk-py/docs/generate_docs.py | 20 ++++++-- .../docs/introspect_exports.py | 15 +++++- apps/agentstack-sdk-py/pyproject.toml | 1 - .../server/store/memory_context_store.py | 2 +- apps/agentstack-sdk-py/uv.lock | 47 ------------------- 6 files changed, 30 insertions(+), 57 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14f30376c7..4d0c3a04d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -347,8 +347,6 @@ All PRs **must** either include corresponding documentation in `docs/development Special care needs to be taken with the `docs/development/reference/` folder, as its contents are automatically generated. Use `mise run agentstack-cli:docs` to regenerate the CLI reference when modifying the CLI interface. Use `mise run agentstack-sdk-py:docs` to regenerate the Python SDK reference when making any changes to it; Additionally, modify the corresponding SDK reference generating scripts in `apps/agentstack-sdk-py/docs` and the docs/docs.json file whenever you change the package import structure to reflect those changes. -Tha same applies to files the `docs/development/reference/` - Try to follow this structure: - **Elevator pitch:** What value this feature brings to the user. diff --git a/apps/agentstack-sdk-py/docs/generate_docs.py b/apps/agentstack-sdk-py/docs/generate_docs.py index 1ce423adf5..3426854285 100644 --- a/apps/agentstack-sdk-py/docs/generate_docs.py +++ b/apps/agentstack-sdk-py/docs/generate_docs.py @@ -88,9 +88,21 @@ "description": "Core server for creating and running A2A-compatible agents", "import_path": "agentstack_sdk.server", "submodule_cards": [ - {"title": "Middleware", "filename": "server-middleware-platform-auth-backend", "description": "Platform authentication middleware"}, - {"title": "Memory context store", "filename": "server-store-memory-context-store", "description": "Context management using in-memory storage"}, - {"title": "Platform context store", "filename": "server-store-platform-context-store", "description": "Context management using platform storage"}, + { + "title": "Middleware", + "filename": "server-middleware-platform-auth-backend", + "description": "Platform authentication middleware", + }, + { + "title": "Memory context store", + "filename": "server-store-memory-context-store", + "description": "Context management using in-memory storage", + }, + { + "title": "Platform context store", + "filename": "server-store-platform-context-store", + "description": "Context management using platform storage", + }, ], }, { @@ -220,7 +232,7 @@ "import_path": "agentstack_sdk.a2a.extensions.ui", }, # ── platform (grouped by sub-module) ────────────────────────────────────── - { + { "json_key": "agentstack_sdk.platform", "filename": "platform", "title": "Platform", diff --git a/apps/agentstack-sdk-py/docs/introspect_exports.py b/apps/agentstack-sdk-py/docs/introspect_exports.py index d23be63768..020157d703 100644 --- a/apps/agentstack-sdk-py/docs/introspect_exports.py +++ b/apps/agentstack-sdk-py/docs/introspect_exports.py @@ -533,7 +533,18 @@ class TypingKind(str, enum.Enum): _TYPE_ALIAS_ANNOTATION_NAMES = {"TypeAlias", "typing.TypeAlias", "typing_extensions.TypeAlias"} -_UNION_TYPE_ALIAS_RE = re.compile(r"^[\w][\w\[\]., ]*(\s*\|\s*[\w][\w\[\]., ]*)+$") + +def _is_top_level_union(val_str: str) -> bool: + """Return True if val_str is an A | B union with at least one | outside brackets.""" + depth = 0 + for ch in val_str: + if ch in "([{": + depth += 1 + elif ch in ")]}": + depth -= 1 + elif ch == "|" and depth == 0: + return True + return False def _get_typing_kind(attr: griffe.Attribute) -> str | None: @@ -555,7 +566,7 @@ def _get_typing_kind(attr: griffe.Attribute) -> str | None: if val_str.startswith(prefix): return kind - if _UNION_TYPE_ALIAS_RE.match(val_str): + if _is_top_level_union(val_str): return TypingKind.UNION_ALIAS return None diff --git a/apps/agentstack-sdk-py/pyproject.toml b/apps/agentstack-sdk-py/pyproject.toml index 20785b48f4..b93d0ce4ac 100644 --- a/apps/agentstack-sdk-py/pyproject.toml +++ b/apps/agentstack-sdk-py/pyproject.toml @@ -28,7 +28,6 @@ dependencies = [ "typing-extensions>=4.15.0", "opentelemetry-instrumentation-httpx>=0.60b1", "opentelemetry-instrumentation-openai>=0.52.3", - "mkgendocs>=0.9.2", ] [dependency-groups] diff --git a/apps/agentstack-sdk-py/src/agentstack_sdk/server/store/memory_context_store.py b/apps/agentstack-sdk-py/src/agentstack_sdk/server/store/memory_context_store.py index e2a23a9e78..ea3306f565 100644 --- a/apps/agentstack-sdk-py/src/agentstack_sdk/server/store/memory_context_store.py +++ b/apps/agentstack-sdk-py/src/agentstack_sdk/server/store/memory_context_store.py @@ -49,7 +49,7 @@ def __init__(self, max_contexts: int = 1000, context_ttl: timedelta = timedelta( Args: max_contexts: Maximum number of contexts to keep in memory - ttl_seconds: Time-to-live for context instances in seconds (default: 1 hour) + context_ttl: Time-to-live for context instances (default: 1 hour) """ self._instances: TTLCache[str, MemoryContextStoreInstance] = TTLCache( maxsize=max_contexts, ttl=context_ttl.total_seconds() diff --git a/apps/agentstack-sdk-py/uv.lock b/apps/agentstack-sdk-py/uv.lock index d1ac59afbd..2ac33b25d6 100644 --- a/apps/agentstack-sdk-py/uv.lock +++ b/apps/agentstack-sdk-py/uv.lock @@ -37,7 +37,6 @@ dependencies = [ { name = "httpx" }, { name = "janus" }, { name = "mcp" }, - { name = "mkgendocs" }, { name = "objprint" }, { name = "opentelemetry-api" }, { name = "opentelemetry-exporter-otlp-proto-http" }, @@ -76,7 +75,6 @@ requires-dist = [ { name = "httpx" }, { name = "janus", specifier = ">=2.0.0" }, { name = "mcp", specifier = ">=1.12.3" }, - { name = "mkgendocs", specifier = ">=0.9.2" }, { name = "objprint", specifier = ">=0.3.0" }, { name = "opentelemetry-api", specifier = ">=1.35.0" }, { name = "opentelemetry-exporter-otlp-proto-http", specifier = ">=1.35.0" }, @@ -276,15 +274,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/5c/0a/a72d10ed65068e115044937873362e6e32fab1b7dce0046aeb224682c989/asgiref-3.11.1-py3-none-any.whl", hash = "sha256:e8667a091e69529631969fd45dc268fa79b99c92c5fcdda727757e52146ec133", size = 24345, upload-time = "2026-02-03T13:30:13.039Z" }, ] -[[package]] -name = "astor" -version = "0.8.1" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/5a/21/75b771132fee241dfe601d39ade629548a9626d1d39f333fde31bc46febe/astor-0.8.1.tar.gz", hash = "sha256:6a6effda93f4e1ce9f618779b2dd1d9d84f1e32812c23a29b3fff6fd7f63fa5e", size = 35090, upload-time = "2019-12-10T01:50:35.51Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/c3/88/97eef84f48fa04fbd6750e62dcceafba6c63c81b7ac1420856c8dcc0a3f9/astor-0.8.1-py2.py3-none-any.whl", hash = "sha256:070a54e890cefb5b3739d19f30f5a5ec840ffc9c50ffa7d23cc9fc1a38ebbfc5", size = 27488, upload-time = "2019-12-10T01:50:33.628Z" }, -] - [[package]] name = "async-lru" version = "2.2.0" @@ -1430,18 +1419,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/6c/77/d7f491cbc05303ac6801651aabeb262d43f319288c1ea96c66b1d2692ff3/lxml-6.0.2-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:27220da5be049e936c3aca06f174e8827ca6445a4353a1995584311487fc4e3e", size = 3518768, upload-time = "2025-09-22T04:04:57.097Z" }, ] -[[package]] -name = "mako" -version = "1.3.10" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "markupsafe" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/9e/38/bd5b78a920a64d708fe6bc8e0a2c075e1389d53bef8413725c63ba041535/mako-1.3.10.tar.gz", hash = "sha256:99579a6f39583fa7e5630a28c3c1f440e4e97a414b80372649c0ce338da2ea28", size = 392474, upload-time = "2025-04-10T12:44:31.16Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/87/fb/99f81ac72ae23375f22b7afdb7642aba97c00a713c217124420147681a2f/mako-1.3.10-py3-none-any.whl", hash = "sha256:baef24a52fc4fc514a0887ac600f9f1cff3d82c61d4d700a1fa84d597b88db59", size = 78509, upload-time = "2025-04-10T12:50:53.297Z" }, -] - [[package]] name = "markdown-it-py" version = "4.0.0" @@ -1562,21 +1539,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979, upload-time = "2022-08-14T12:40:09.779Z" }, ] -[[package]] -name = "mkgendocs" -version = "0.9.2" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "astor" }, - { name = "mako" }, - { name = "pyyaml" }, - { name = "six" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/fb/a0/9505f017d1fe5ca8cffb9849f49aebaa4255301d3bef517494d836608073/mkgendocs-0.9.2.tar.gz", hash = "sha256:556784e7d6830b1d9330ec8ca372b7db780eb1083f573b162cbd80f9f493c000", size = 16539, upload-time = "2022-08-11T23:58:40.895Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/a3/dd/3cb20e728256026d5624d6601224ee418854da1a42c350990c51d03f62b4/mkgendocs-0.9.2-py3-none-any.whl", hash = "sha256:4ca8f695aca1741e5fe4728713598eba942447650bf2c84f2c27f33413f57417", size = 15718, upload-time = "2022-08-11T23:58:39.596Z" }, -] - [[package]] name = "multidict" version = "6.7.1" @@ -2715,15 +2677,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/e0/f9/0595336914c5619e5f28a1fb793285925a8cd4b432c9da0a987836c7f822/shellingham-1.5.4-py2.py3-none-any.whl", hash = "sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686", size = 9755, upload-time = "2023-10-24T04:13:38.866Z" }, ] -[[package]] -name = "six" -version = "1.17.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/94/e7/b2c673351809dca68a0e064b6af791aa332cf192da575fd474ed7d6f16a2/six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81", size = 34031, upload-time = "2024-12-04T17:35:28.174Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050, upload-time = "2024-12-04T17:35:26.475Z" }, -] - [[package]] name = "sniffio" version = "1.3.1" From 1f598ed6edc83483cf7e87e723634b8a2b676ac0 Mon Sep 17 00:00:00 2001 From: Jan Jeliga Date: Thu, 5 Mar 2026 15:53:07 +0100 Subject: [PATCH 8/8] github ci docs checks extension Signed-off-by: Jan Jeliga --- .github/pull_request_template.md | 7 ++- .github/workflows/docs-check.yaml | 61 ++++++++++++++++--- .../src/agentstack_cli/async_typer.py | 3 + 3 files changed, 60 insertions(+), 11 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 17e9be8023..35eeef01e4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,6 +7,9 @@ ## Documentation -- [ ] No Docs Needed: +- [ ] **No Docs Needed (skips all doc checks below)** +- [ ] No CLI Docs Needed (skip check for `docs/development/reference/cli-reference.mdx`) +- [ ] No Python SDK Docs Needed (skip check for `docs/development/reference/python-sdk/`) +- [ ] No General Docs Needed (skip check for general docs changes) -If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why. \ No newline at end of file +If this PR adds a new feature or changes existing behavior, make sure the relevant documentation is updated. If docs are not needed for a specific area, check the corresponding box above and explain why. \ No newline at end of file diff --git a/.github/workflows/docs-check.yaml b/.github/workflows/docs-check.yaml index cd3a535026..e4b8d09c51 100644 --- a/.github/workflows/docs-check.yaml +++ b/.github/workflows/docs-check.yaml @@ -15,29 +15,72 @@ jobs: uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8 with: script: | - if (/\[x\].*no docs needed/i.test(context.payload.pull_request.body || '')) { + const body = context.payload.pull_request.body || ''; + + if (/\[x\].*no docs needed/i.test(body)) { core.info('🟡 "No Docs Needed" checked — skipping docs enforcement.'); return; } - + if (context.payload.pull_request.user.login === 'renovate[bot]') { core.info('🤖 Renovate PR detected — skipping docs enforcement.'); return; } - + + const noCliDocs = /\[x\].*no cli docs needed/i.test(body); + const noSdkDocs = /\[x\].*no python sdk docs needed/i.test(body); + const noGeneralDocs = /\[x\].*no general docs needed/i.test(body); + const filenames = (await github.rest.pulls.listFiles({ owner: context.repo.owner, repo: context.repo.repo, pull_number: context.payload.pull_request.number })).data.map(f => f.filename); - + if (filenames.some(f => f.startsWith('docs/stable/'))) { core.setFailed('❌ Changes to "stable" documentation are not allowed. Please make changes in the "development" directory instead.'); return; } - - if (filenames.some(f => /\.mdx?$/.test(f))) { - core.info('✅ Docs updated.'); - } else { - core.setFailed('❌ No docs changes found and "No Docs Needed" not checked.'); + + const errors = []; + + // 1. CLI changes require CLI reference doc update + if (filenames.some(f => f.startsWith('apps/agentstack-cli/'))) { + if (noCliDocs) { + core.info('🟡 "No CLI Docs Needed" checked — skipping CLI docs check.'); + } else if (!filenames.some(f => f === 'docs/development/reference/cli-reference.mdx')) { + errors.push('❌ Changes in apps/agentstack-cli require an update to docs/development/reference/cli-reference.mdx.'); + } else { + core.info('✅ CLI reference docs updated.'); + } + } + + // 2. Python SDK changes require Python SDK reference docs update + if (filenames.some(f => f.startsWith('apps/agentstack-sdk-py/'))) { + if (noSdkDocs) { + core.info('🟡 "No Python SDK Docs Needed" checked — skipping Python SDK docs check.'); + } else if (!filenames.some(f => f.startsWith('docs/development/reference/python-sdk/'))) { + errors.push('❌ Changes in apps/agentstack-sdk-py require updates in docs/development/reference/python-sdk/.'); + } else { + core.info('✅ Python SDK reference docs updated.'); + } + } + + // 3. Other apps/ changes require general docs update (outside reference/) + if (filenames.some(f => + f.startsWith('apps/') && + !f.startsWith('apps/agentstack-cli/') && + !f.startsWith('apps/agentstack-sdk-py/') + )) { + if (noGeneralDocs) { + core.info('🟡 "No General Docs Needed" checked — skipping general docs check.'); + } else if (!filenames.some(f => f.startsWith('docs/development') && !f.startsWith('docs/development/reference/'))) { + errors.push('❌ Changes in apps/ require docs updates outside of the reference subfolder.'); + } else { + core.info('✅ Docs updated for other apps changes.'); + } + } + + if (errors.length > 0) { + core.setFailed(errors.join('\n')); } diff --git a/apps/agentstack-cli/src/agentstack_cli/async_typer.py b/apps/agentstack-cli/src/agentstack_cli/async_typer.py index 9efe065786..cd2be054e2 100644 --- a/apps/agentstack-cli/src/agentstack_cli/async_typer.py +++ b/apps/agentstack-cli/src/agentstack_cli/async_typer.py @@ -37,6 +37,9 @@ def __rich_console__(self, *args, **kwargs) -> RenderResult: Markdown.elements["heading_open"] = _LeftAlignedHeading +class test: + pass + @contextmanager def create_table(*args, no_wrap: bool = True, **kwargs) -> Iterator[Table]: