Generated SDK baseline differences
The published SDK or generator baseline differs from the baseline used by the OpenAPI changelog.
Removed from the stable API surface (24):
Changed types or signatures on the stable surface (143):
Removed from the beta surface (20):
Changed types or signatures in beta (10):
Now required on an existing beta model (4):
Generated surface details
Stable compatibility changes
DeploymentKoyebBackendSpec
UnknownDeploymentWorkerSpecResponseBackendSpec
DeploymentKoyebBackendSpec.build_directory
DeploymentKoyebBackendSpec.dockerfile_path
DeploymentKoyebBackendSpec.type
DeploymentResourceConfig.cpu_limit
DeploymentResourceConfig.cpu_request
DeploymentResourceConfig.memory_limit
DeploymentResourceConfig.memory_request
DeploymentResourceConfigUpdate.cpu_limit
DeploymentResourceConfigUpdate.cpu_request
DeploymentResourceConfigUpdate.memory_limit
DeploymentResourceConfigUpdate.memory_request
DeploymentWorkerSpecInput.entrypoint
DeploymentWorkerSpecInput.working_dir
DeploymentWorkerSpecResponse.commit_sha
DeploymentWorkerSpecResponse.entrypoint
DeploymentWorkerSpecResponse.working_dir
UnknownDeploymentWorkerSpecResponseBackendSpec.is_unknown
UnknownDeploymentWorkerSpecResponseBackendSpec.raw
UnknownDeploymentWorkerSpecResponseBackendSpec.type
WorkflowsWorkerSpecUpdate.entrypoint
WorkflowsWorkerSpecUpdate.working_dir
DeploymentKoyebBackendSpec.serialize_model
Stable type changes
ActivityTaskCompletedResponse.chain_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskCompletedResponse.continued_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskCompletedResponse.first_execution_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskCompletedResponse.schedule_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskCompletedResponseTypedDict.chain_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskCompletedResponseTypedDict.continued_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskCompletedResponseTypedDict.first_execution_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskCompletedResponseTypedDict.schedule_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskFailedResponse.chain_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskFailedResponse.continued_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskFailedResponse.first_execution_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskFailedResponse.schedule_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskFailedResponseTypedDict.chain_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskFailedResponseTypedDict.continued_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskFailedResponseTypedDict.first_execution_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskFailedResponseTypedDict.schedule_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskRetryingResponse.chain_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskRetryingResponse.continued_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskRetryingResponse.first_execution_run_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskRetryingResponse.schedule_id: Nullable[str] -> OptionalNullable[str]
ActivityTaskRetryingResponseTypedDict.chain_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskRetryingResponseTypedDict.continued_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskRetryingResponseTypedDict.first_execution_run_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskRetryingResponseTypedDict.schedule_id: Nullable[str] -> NotRequired[Nullable[str]]
ActivityTaskStartedResponse.chain_run_id: Nullable[str] -> OptionalNullable[str]
Beta surface changes
ConnectorDeleteOrganizationCredentialsV1Request
ConnectorDeleteUserCredentialsV1Request
ConnectorDeleteWorkspaceCredentialsV1Request
ConnectorDeleteOrganizationCredentialsV1Request.connector_id_or_name
ConnectorDeleteOrganizationCredentialsV1Request.credentials_name
ConnectorDeleteUserCredentialsV1Request.connector_id_or_name
ConnectorDeleteUserCredentialsV1Request.credentials_name
ConnectorDeleteWorkspaceCredentialsV1Request.connector_id_or_name
ConnectorDeleteWorkspaceCredentialsV1Request.credentials_name
ConnectorGetV1Request.fetch_customer_data
ConnectorListToolsV1Request.page
ConnectorsQueryFilters.active
CreatePipelineConfigRequest.definitions
UpdatePipelineConfigRequest.definitions
Connectors.delete_organization_credentials
Connectors.delete_organization_credentials_async
Connectors.delete_user_credentials
Connectors.delete_user_credentials_async
Connectors.delete_workspace_credentials
Connectors.delete_workspace_credentials_async
PipelineConfig.definitions: List[PipelineConfigDefinition] -> Optional[List[PipelineConfigDefinition]]
PipelineConfigTypedDict.definitions: List[PipelineConfigDefinitionTypedDict] -> NotRequired[List[PipelineConfigDefinitionTypedDict]]
SearchRequest.retriever: Retriever -> SearchRequestRetriever
SearchRequestTypedDict.retriever: RetrieverTypedDict -> SearchRequestRetrieverTypedDict
UsersAPIGetIdentitySecurity.dashboard_user_context_auth: Annotated[str, FieldMetadata(security=SecurityMetadata(scheme=True, scheme_type='apiKey', sub_type='header', field_name='x-api-key'))] -> Annotated[Optional[str], FieldMetadata(security=SecurityMetadata(scheme=True, scheme_type='apiKey', sub_type='header', field_name='x-api-key'))]
UsersAPIGetIdentitySecurityTypedDict.dashboard_user_context_auth: str -> NotRequired[str]
UsersAPIListOrganizationsSecurity.dashboard_user_context_auth: Annotated[str, FieldMetadata(security=SecurityMetadata(scheme=True, scheme_type='apiKey', sub_type='header', field_name='x-api-key'))] -> Annotated[Optional[str], FieldMetadata(security=SecurityMetadata(scheme=True, scheme_type='apiKey', sub_type='header', field_name='x-api-key'))]
UsersAPIListOrganizationsSecurityTypedDict.dashboard_user_context_auth: str -> NotRequired[str]
UsersAPIListWorkspacesSecurity.dashboard_user_context_auth: Annotated[str, FieldMetadata(security=SecurityMetadata(scheme=True, scheme_type='apiKey', sub_type='header', field_name='x-api-key'))] -> Annotated[Optional[str], FieldMetadata(security=SecurityMetadata(scheme=True, scheme_type='apiKey', sub_type='header', field_name='x-api-key'))]
UsersAPIListWorkspacesSecurityTypedDict.dashboard_user_context_auth: str -> NotRequired[str]
CreatePipelineConfigRequest.definition
ManagedIndexResponse.creator_id
PipelineConfig.definition
UpdatePipelineConfigRequest.definition
API changes
Highlights
- The SDK uses HTTPX2 instead of HTTPX, and the
mcpandagentsextras MCP 2.2. A client passed asclient=orasync_client=must be anhttpx2client, and raw requests, responses and transport errors arehttpx2types. See MIGRATION.md for every breaking change in this release. - Chat and agents completions no longer accept the
code_interpreter,web_searchandweb_search_premiumtools; use them through the Conversations API or an agent. - Workflow deployments: the
koyebbackend is nowmistral_cloud(DeploymentKoyebBackendSpecis replaced byDeploymentMistralCloudBackendSpec), the Kubernetes backend can no longer be set, the CPU/memory,entrypoint,working_dirandcommit_shafields are removed, andUnknownDeploymentWorkerSpecResponseBackendSpecis renamedUnknownBackendSpec. - New:
Mistral()authenticates from a service-account token atMISTRAL_SA_TOKEN_PATH;beta.connectors.mcp_client()andbeta.connectors.http_client()call connectors directly through the Connectors Gateway, whose own failures raiseConnectorsGatewayError.
Breaking changes
- Removed fields
cpu_limit,cpu_request,memory_limit, andmemory_requestfrom responseresourcesacross workflows deployments (6 operations). - Changed field
typeacross workflows deployments (6 operations). - Removed fields
commit_sha,entrypoint, andworking_dirfrom responsespecacross workflows deployments (6 operations). - Removed fields
cpu_limit,cpu_request,memory_limit, andmemory_requestfrom requestresourcesinsdk.workflows.deployments.update_deployment()andsdk.workflows.deployments.create_deployment(). - Changed field
backend_specinsdk.workflows.deployments.update_deployment()andsdk.workflows.deployments.create_deployment(). - Removed fields
entrypointandworking_dirfrom requestspecinsdk.workflows.deployments.update_deployment()andsdk.workflows.deployments.create_deployment(). - Removed fields
cpu_limit,cpu_request,memory_limit, andmemory_requestfrom responsemanaged.resourcesinsdk.workflows.deployments.get_deployment(). - Changed field
typeinsdk.workflows.deployments.get_deployment(). - Removed fields
commit_sha,entrypoint, andworking_dirfrom responsemanaged.specinsdk.workflows.deployments.get_deployment(). - Removed fields
cpu_limit,cpu_request,memory_limit, andmemory_requestfrom responsedeployments[].managed.resourcesinsdk.workflows.deployments.list_deployments(). - Changed field
typeinsdk.workflows.deployments.list_deployments(). - Removed fields
commit_sha,entrypoint, andworking_dirfrom responsedeployments[].managed.specinsdk.workflows.deployments.list_deployments(). - Removed variants
code_interpreter,web_search, andweb_search_premiumfrom requesttools[]insdk.chat.complete(),sdk.chat.stream(),sdk.agents.complete(), andsdk.agents.stream().
Beta API changes
sdk.beta.connectors: removeddelete_workspace_credentials(),delete_organization_credentials(), anddelete_user_credentials(); addeddelete_credentials().- Removed field
fetch_customer_datafrom request insdk.beta.connectors.get(). - Added required field
definitionto request insdk.beta.observability.evaluations.create_pipeline_config()andsdk.beta.observability.evaluations.update_pipeline_config(). - Removed field
definitionsfrom request insdk.beta.observability.evaluations.create_pipeline_config()andsdk.beta.observability.evaluations.update_pipeline_config(). - Removed field
pagefrom request insdk.beta.connectors.list_tools(). - Removed field
activefrom requestquery_filtersinsdk.beta.connectors.list().
Added operations
Stable:
sdk.workflows.deployments.unharden_deployment()sdk.audio.voices.search()
Beta:
sdk.beta.observability.evaluations.list_pipelines()sdk.beta.observability.datasets.import_from_spans()sdk.beta.rag.managed_indexes.get_chunk()sdk.beta.rag.managed_indexes.grep()sdk.beta.rag.managed_indexes.read()sdk.beta.rag.managed_indexes.navigate()sdk.beta.observability.spans.aggregate_span_evaluations()sdk.beta.observability.evaluations.delete_pipeline()sdk.beta.observability.evaluations.update_pipeline()sdk.beta.observability.evaluations.get_pipeline()sdk.beta.observability.evaluations.create_pipeline()
Deprecated operations
Beta:
sdk.beta.connectors.call_tool()
Schema changes
- Added response field
definitioninsdk.beta.observability.evaluations.create_pipeline_config(),sdk.beta.observability.evaluations.update_pipeline_config(),sdk.beta.observability.evaluations.list_pipeline_configs(), andsdk.beta.observability.evaluations.get_pipeline_config(). - Changed response field
definitionsinsdk.beta.observability.evaluations.create_pipeline_config(),sdk.beta.observability.evaluations.update_pipeline_config(),sdk.beta.observability.evaluations.list_pipeline_configs(), andsdk.beta.observability.evaluations.get_pipeline_config(). - Added enum values
PIPELINE_ALREADY_EXISTSandPIPELINE_NOT_FOUNDacross beta observability evaluations, beta observability traces, beta observability judges, beta observability datasets, beta observability datasets records, beta observability spans, beta observability logs (48 operations). - Added response fields
runtime_credential_id,runtime_principal_type, andsecretsacross workflows deployments (8 operations). - Added request field
ownerinsdk.workflows.deployments.list_deployments(). - Added request enum value
mistral_mcpacross chat, agents, beta conversations, classifiers (7 operations). - Added response enum value
mistral_mcpacross chat, agents, beta conversations, FIM (8 operations). - Added response field
source_attribute_keyinsdk.beta.observability.traces.get_trace_fields(),sdk.beta.observability.logs.list(),sdk.beta.observability.spans.list_span_fields(), andsdk.beta.observability.spans.list_span_eval_fields(). - Added request fields
orderandqinsdk.beta.service_accounts.list(). - Added response field
resultacross beta observability datasets (5 operations). - Added request field
client_scopesinsdk.beta.connectors.create()andsdk.beta.connectors.update(). - Added request fields
creator_id,name, andstatusinsdk.beta.rag.managed_indexes.list(). - Added response field
creator_idinsdk.beta.rag.managed_indexes.list(),sdk.beta.rag.managed_indexes.create(),sdk.beta.rag.managed_indexes.get(), andsdk.beta.rag.managed_indexes.update(). - Added request field
max_candidatesinsdk.beta.rag.managed_indexes.search(). - Added request variant
rrfinsdk.beta.rag.managed_indexes.search(). - Added request field
bearer_user_context_authinsdk.beta.users.get_identity(),sdk.beta.users.list_organizations(), andsdk.beta.users.list_workspaces(). - Changed request field
dashboard_user_context_authinsdk.beta.users.get_identity(),sdk.beta.users.list_organizations(), andsdk.beta.users.list_workspaces(). - Changed response fields
chain_run_id,continued_run_id,first_execution_run_id, andschedule_idinsdk.workflows.events.get_workflow_events()andsdk.events.get_workflow_events(). - Added request field
log_typeinsdk.workflows.deployments.get_deployment_logs().
Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.796.4 (2.935.1) https://github.com/speakeasy-api/speakeasy
Generated
- [python v3.0.0] .
Releases
- [PyPI v3.0.0] https://pypi.org/project/mistralai/3.0.0 - .
Publishing Completed