Overview Use Cases Connectors Authentication Getting Started with the Python SDK 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 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 model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

listDocumentRetrievers GET

Copy GET

List all the document retrievers.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	projectId	str	The ID of project that the document retriever is created in.
No	limit	int	The number of document retrievers to return.
No	startAfterId	str	An offset parameter to exclude all document retrievers up to this specified ID.

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
result	list[DocumentRetriever]

Exceptions:

TYPE	WHEN
DataNotFoundError	`projectId` is not found.
DataNotFoundError	`startAfterId` is not found.

Language: