Overview Use Cases Connectors Authentication Getting Started with the Python SDK API API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers createDocumentRetriever createDocumentRetrieverVersion deleteDocumentRetriever deleteDocumentRetrieverVersion describeDocumentRetriever describeDocumentRetrieverByName describeDocumentRetrieverVersion getDocumentSnippet getMatchingDocuments getRelevantSnippets listDocumentRetrieverVersions listDocumentRetrievers renameDocumentRetriever restartDocumentRetriever documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps mcp_server_connections model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project project_scopes python_function refresh routellm secrets streaming streaming_connectors upload user webhooks API Classes API Inputs Documentation Chat Bot API Search How to

Method

restartDocumentRetriever POST

Copy POST

Restart the document retriever if it is stopped or has failed. This will start the deployment of the document retriever,

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	documentRetrieverId	str	A unique string identifier associated with the document retriever.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY	TYPE	DESCRIPTION
success	Boolean	true if the call succeeded, false if there was an error

Exceptions:

TYPE	WHEN
DataNotFoundError	`documentRetrieverId` is not found.

Language: