h2oGPTe Python Client
h2ogpte is the Python client library for H2O.ai’s h2oGPTe,
a RAG (Retrieval-Augmented Generation) based platform built on top of open-source software components such as h2oGPT,
hnswlib, Torch, Transformers, Golang, Python, k8s, Docker, PyMuPDF, DocTR, and many more.
h2oGPTe is designed to help organizations improve their business using generative AI.
It focuses on scaling as your organization expands the number of use cases, users,
and documents, and has the goal of being your one stop for integrating any model or
LLM functionality into your business.
Main features:
Contextualize chat with your own data using RAG (Retrieval-Augmented Generation).
Scalable backend and frontend, multi-user, high throughput.
Fully containerized with Kubernetes.
Multi-modal support for text, images, and audio.
- Highly customizable prompting for:
talk to LLM
talk to document
talk to collection of documents
talk to every page of a collection (Map/Reduce), summary, extraction
LLM agnostic - choose the model you need for your use case.
Installation
Getting Started
Tutorials
Examples
Python API
- h2oGPTe Python API
- h2ogpte package
- Submodules
- h2ogpte.h2ogpte module
H2OGPTEH2OGPTE.add_agent_key()H2OGPTE.add_custom_agent_tool()H2OGPTE.add_role_to_group()H2OGPTE.add_role_to_user()H2OGPTE.add_user_document_permission()H2OGPTE.answer_question()H2OGPTE.archive_collection()H2OGPTE.assign_agent_key_for_tool()H2OGPTE.assign_permissions_to_role()H2OGPTE.bulk_delete_global_configurations()H2OGPTE.bulk_delete_role_configurations()H2OGPTE.bulk_delete_user_configurations_for_user()H2OGPTE.cancel_job()H2OGPTE.cancel_user_job()H2OGPTE.confirm_current_user_deletion()H2OGPTE.count_assets()H2OGPTE.count_chat_sessions()H2OGPTE.count_chat_sessions_for_collection()H2OGPTE.count_collections()H2OGPTE.count_documents()H2OGPTE.count_documents_in_collection()H2OGPTE.count_documents_owned_by_me()H2OGPTE.count_prompt_templates()H2OGPTE.count_question_reply_feedback()H2OGPTE.create_api_key_for_user()H2OGPTE.create_chat_session()H2OGPTE.create_chat_session_on_default_collection()H2OGPTE.create_collection()H2OGPTE.create_extractor()H2OGPTE.create_prompt_template()H2OGPTE.create_secret()H2OGPTE.create_tag()H2OGPTE.create_topic_model()H2OGPTE.create_user_group()H2OGPTE.create_user_role()H2OGPTE.deactivate_api_key()H2OGPTE.delete_agent_directories()H2OGPTE.delete_agent_keys()H2OGPTE.delete_agent_server_files()H2OGPTE.delete_agent_tool_association()H2OGPTE.delete_agent_tool_preference()H2OGPTE.delete_api_keys()H2OGPTE.delete_chat_messages()H2OGPTE.delete_chat_sessions()H2OGPTE.delete_collections()H2OGPTE.delete_collections_as_admin()H2OGPTE.delete_custom_agent_tool()H2OGPTE.delete_document_summaries()H2OGPTE.delete_documents()H2OGPTE.delete_documents_from_collection()H2OGPTE.delete_extractor()H2OGPTE.delete_multiple_agent_directories()H2OGPTE.delete_prompt_templates()H2OGPTE.delete_secret()H2OGPTE.delete_upload()H2OGPTE.delete_user_groups_by_ids()H2OGPTE.delete_user_groups_by_names()H2OGPTE.delete_user_roles_by_ids()H2OGPTE.delete_user_roles_by_names()H2OGPTE.download_document()H2OGPTE.download_reference_highlighting()H2OGPTE.encode_for_retrieval()H2OGPTE.extract_data()H2OGPTE.get_agent_key_tool_associations()H2OGPTE.get_agent_keys()H2OGPTE.get_agent_server_files()H2OGPTE.get_agent_tool_preference()H2OGPTE.get_agent_tools_dict()H2OGPTE.get_all_directory_stats()H2OGPTE.get_chat_session_prompt_template()H2OGPTE.get_chat_session_questions()H2OGPTE.get_chunks()H2OGPTE.get_collection()H2OGPTE.get_collection_for_chat_session()H2OGPTE.get_collection_prompt_template()H2OGPTE.get_collection_questions()H2OGPTE.get_custom_agent_tools()H2OGPTE.get_default_collection()H2OGPTE.get_directory_stats()H2OGPTE.get_document()H2OGPTE.get_document_content()H2OGPTE.get_extractor()H2OGPTE.get_global_configurations()H2OGPTE.get_global_configurations_by_admin()H2OGPTE.get_guardrails_settings()H2OGPTE.get_h2ogpt_system_stats()H2OGPTE.get_job()H2OGPTE.get_llm_and_auto_reasoning_llm_names()H2OGPTE.get_llm_and_auto_vision_llm_names()H2OGPTE.get_llm_name_for_rest()H2OGPTE.get_llm_names()H2OGPTE.get_llm_performance_by_llm()H2OGPTE.get_llm_usage_24h()H2OGPTE.get_llm_usage_24h_by_llm()H2OGPTE.get_llm_usage_24h_with_limits()H2OGPTE.get_llm_usage_6h()H2OGPTE.get_llm_usage_6h_by_llm()H2OGPTE.get_llm_usage_by_llm()H2OGPTE.get_llm_usage_by_llm_and_user()H2OGPTE.get_llm_usage_by_user()H2OGPTE.get_llm_usage_with_limits()H2OGPTE.get_llms()H2OGPTE.get_meta()H2OGPTE.get_prompt_template()H2OGPTE.get_reasoning_capable_llm_names()H2OGPTE.get_scheduler_stats()H2OGPTE.get_secret()H2OGPTE.get_secret_value()H2OGPTE.get_tag()H2OGPTE.get_user_all_agent_directories()H2OGPTE.get_user_configurations()H2OGPTE.get_user_configurations_for_user()H2OGPTE.get_vision_capable_llm_names()H2OGPTE.import_collection_into_collection()H2OGPTE.import_document_into_collection()H2OGPTE.ingest_agent_only_to_standard()H2OGPTE.ingest_from_azure_blob_storage()H2OGPTE.ingest_from_file_system()H2OGPTE.ingest_from_gcs()H2OGPTE.ingest_from_plain_text()H2OGPTE.ingest_from_s3()H2OGPTE.ingest_uploads()H2OGPTE.ingest_website()H2OGPTE.is_collection_permission_granted()H2OGPTE.is_permission_granted()H2OGPTE.list_all_api_keys()H2OGPTE.list_all_collections_sort()H2OGPTE.list_all_jobs()H2OGPTE.list_all_recent_prompt_templates()H2OGPTE.list_all_recent_prompt_templates_sort()H2OGPTE.list_all_tags()H2OGPTE.list_chat_message_meta_part()H2OGPTE.list_chat_message_references()H2OGPTE.list_chat_messages()H2OGPTE.list_chat_messages_full()H2OGPTE.list_chat_sessions_for_collection()H2OGPTE.list_chat_sessions_for_document()H2OGPTE.list_collection_group_permissions()H2OGPTE.list_collection_permissions()H2OGPTE.list_collections_for_document()H2OGPTE.list_document_chunks()H2OGPTE.list_documents_from_tags()H2OGPTE.list_documents_in_collection()H2OGPTE.list_embedding_models()H2OGPTE.list_extractors()H2OGPTE.list_group_permissions()H2OGPTE.list_group_permissions_by_name()H2OGPTE.list_group_roles()H2OGPTE.list_jobs()H2OGPTE.list_list_chat_message_meta()H2OGPTE.list_prompt_group_permissions()H2OGPTE.list_prompt_permissions()H2OGPTE.list_question_reply_feedback_data()H2OGPTE.list_recent_chat_sessions()H2OGPTE.list_recent_collections()H2OGPTE.list_recent_collections_filter()H2OGPTE.list_recent_collections_metadata_filter()H2OGPTE.list_recent_collections_sort()H2OGPTE.list_recent_document_summaries()H2OGPTE.list_recent_documents()H2OGPTE.list_recent_documents_with_summaries()H2OGPTE.list_recent_documents_with_summaries_sort()H2OGPTE.list_recent_prompt_templates()H2OGPTE.list_recent_prompt_templates_sort()H2OGPTE.list_role_configurations()H2OGPTE.list_secret_ids()H2OGPTE.list_system_groups()H2OGPTE.list_system_permissions()H2OGPTE.list_system_roles()H2OGPTE.list_upload()H2OGPTE.list_user_permissions()H2OGPTE.list_user_role_permissions()H2OGPTE.list_user_roles()H2OGPTE.list_users()H2OGPTE.make_collection_private()H2OGPTE.make_collection_public()H2OGPTE.make_prompt_template_private()H2OGPTE.make_prompt_template_public()H2OGPTE.match_chunks()H2OGPTE.process_document()H2OGPTE.remove_collection_expiry_date()H2OGPTE.remove_collection_inactivity_interval()H2OGPTE.remove_collection_size_limit()H2OGPTE.remove_collection_thumbnail()H2OGPTE.remove_role_from_group()H2OGPTE.remove_role_from_user()H2OGPTE.rename_chat_session()H2OGPTE.request_current_user_deletion()H2OGPTE.reset_and_share_prompt_template()H2OGPTE.reset_and_share_prompt_template_with_groups()H2OGPTE.reset_collection_prompt_settings()H2OGPTE.reset_roles_for_group()H2OGPTE.reset_roles_for_user()H2OGPTE.reset_user_configurations_for_user()H2OGPTE.run_selftest()H2OGPTE.search_chunks()H2OGPTE.set_api_key_expiration()H2OGPTE.set_chat_message_votes()H2OGPTE.set_chat_session_collection()H2OGPTE.set_chat_session_prompt_template()H2OGPTE.set_collection_expiry_date()H2OGPTE.set_collection_inactivity_interval()H2OGPTE.set_collection_prompt_template()H2OGPTE.set_collection_size_limit()H2OGPTE.set_collection_thumbnail()H2OGPTE.set_default_prompt_template_visibility()H2OGPTE.set_global_configuration()H2OGPTE.set_role_configuration()H2OGPTE.set_role_priority()H2OGPTE.set_user_configuration_for_user()H2OGPTE.share_chat_session()H2OGPTE.share_collection()H2OGPTE.share_collection_with_group()H2OGPTE.share_prompt()H2OGPTE.share_prompt_with_group()H2OGPTE.summarize_content()H2OGPTE.summarize_document()H2OGPTE.tag_document()H2OGPTE.unarchive_collection()H2OGPTE.unshare_collection()H2OGPTE.unshare_collection_for_all()H2OGPTE.unshare_collection_from_group()H2OGPTE.unshare_prompt()H2OGPTE.unshare_prompt_for_all()H2OGPTE.unshare_prompt_from_group()H2OGPTE.untag_document()H2OGPTE.update_agent_key()H2OGPTE.update_agent_tool_preference()H2OGPTE.update_collection()H2OGPTE.update_collection_metadata()H2OGPTE.update_collection_rag_type()H2OGPTE.update_collection_settings()H2OGPTE.update_custom_agent_tool()H2OGPTE.update_document_metadata()H2OGPTE.update_document_name()H2OGPTE.update_document_uri()H2OGPTE.update_prompt_template()H2OGPTE.update_question_reply_feedback()H2OGPTE.update_secret()H2OGPTE.update_tag()H2OGPTE.upload()
- h2ogpte.session module
- h2ogpte.types module
APIKeyAnswerChatAcknowledgementChatMessageChatMessageFullChatMessageMetaChatMessageReferenceChatMessageReference.chunk_idChatMessageReference.collection_idChatMessageReference.contentChatMessageReference.document_idChatMessageReference.document_nameChatMessageReference.model_configChatMessageReference.pagesChatMessageReference.scoreChatMessageReference.uriChatMessageReference.were_references_deleted
ChatRequestChatRequest.bodyChatRequest.correlation_idChatRequest.image_batch_final_promptChatRequest.image_batch_image_promptChatRequest.include_chat_historyChatRequest.llmChatRequest.llm_argsChatRequest.metadata_filterChatRequest.modeChatRequest.pre_prompt_queryChatRequest.pre_prompt_summaryChatRequest.prompt_queryChatRequest.prompt_summaryChatRequest.rag_configChatRequest.self_reflection_configChatRequest.session_idChatRequest.system_promptChatRequest.tChatRequest.tags
ChatResponseChatSessionCountChatSessionForCollectionChatSessionForDocumentChatSessionInfoChatShareUrlChunkCollectionCollection.chat_settingsCollection.collection_settingsCollection.created_atCollection.descriptionCollection.document_countCollection.document_sizeCollection.embedding_modelCollection.expiry_dateCollection.idCollection.inactivity_intervalCollection.is_publicCollection.metadata_dictCollection.model_configCollection.nameCollection.prompt_template_idCollection.rag_typeCollection.size_limitCollection.statusCollection.thumbnailCollection.updated_atCollection.username
CollectionCountCollectionInfoCollectionInfo.archived_atCollectionInfo.descriptionCollectionInfo.document_countCollectionInfo.document_sizeCollectionInfo.expiry_dateCollectionInfo.idCollectionInfo.inactivity_intervalCollectionInfo.is_publicCollectionInfo.metadata_dictCollectionInfo.model_configCollectionInfo.nameCollectionInfo.sessions_countCollectionInfo.size_limitCollectionInfo.statusCollectionInfo.updated_atCollectionInfo.user_countCollectionInfo.username
ConfigItemDocumentDocument.connectorDocument.created_atDocument.guardrails_settingsDocument.idDocument.meta_data_dictDocument.metadata_dictDocument.model_configDocument.nameDocument.original_mtimeDocument.original_typeDocument.page_countDocument.page_layout_dictDocument.page_ocr_model_dictDocument.sizeDocument.statusDocument.typeDocument.updated_atDocument.uriDocument.user_source_file
DocumentCountDocumentInfoDocumentInfo.connectorDocumentInfo.guardrails_settingsDocumentInfo.idDocumentInfo.meta_data_dictDocumentInfo.metadata_dictDocumentInfo.model_configDocumentInfo.nameDocumentInfo.original_typeDocumentInfo.page_countDocumentInfo.page_layout_dictDocumentInfo.page_ocr_model_dictDocumentInfo.sizeDocumentInfo.statusDocumentInfo.typeDocumentInfo.updated_atDocumentInfo.uriDocumentInfo.user_source_fileDocumentInfo.username
DocumentInfoSummaryDocumentInfoSummary.connectorDocumentInfoSummary.guardrails_settingsDocumentInfoSummary.idDocumentInfoSummary.meta_data_dictDocumentInfoSummary.metadata_dictDocumentInfoSummary.model_configDocumentInfoSummary.nameDocumentInfoSummary.original_typeDocumentInfoSummary.page_countDocumentInfoSummary.page_layout_dictDocumentInfoSummary.page_ocr_model_dictDocumentInfoSummary.sizeDocumentInfoSummary.statusDocumentInfoSummary.summaryDocumentInfoSummary.summary_parametersDocumentInfoSummary.typeDocumentInfoSummary.updated_atDocumentInfoSummary.uriDocumentInfoSummary.usage_statsDocumentInfoSummary.user_source_fileDocumentInfoSummary.username
DocumentSummaryExtractionAnswerExtractorGlobalConfigItemGroupSharePermissionIdentifierJobJobKindJobKind.CreateTopicModelJobJobKind.DeleteChatSessionsJobJobKind.DeleteCollectionThumbnailJobJobKind.DeleteCollectionsAsAdminJobJobKind.DeleteCollectionsJobJobKind.DeleteDocumentsFromCollectionJobJobKind.DeleteDocumentsJobJobKind.DeleteUserJobJobKind.DocumentSummaryJobJobKind.EvalCollectionJobJobKind.EvalMessageJobJobKind.ImportCollectionIntoCollectionJobJobKind.ImportDocumentIntoCollectionJobJobKind.IndexFilesJobJobKind.IngestAgentOnlyToStandardJobJobKind.IngestFromCloudStorageJobJobKind.IngestFromFileSystemJobJobKind.IngestPlainTextJobJobKind.IngestUploadsJobJobKind.IngestWebsiteJobJobKind.NoOpJobJobKind.UpdateCollectionStatsJobJobKind.UpdateCollectionThumbnailJob
JobStatusLLMPerformanceLLMUsageLLMUsageLimitLLMWithUserUsageMetaMetaUIConfigMetaUIConfig.chat_logoMetaUIConfig.chat_nameMetaUIConfig.greetingMetaUIConfig.logoMetaUIConfig.model_configMetaUIConfig.primary_colorMetaUIConfig.public_modeMetaUIConfig.show_evalMetaUIConfig.show_extractorsMetaUIConfig.show_live_logsMetaUIConfig.show_private_buttonMetaUIConfig.show_workers_status
ObjectCountPartialChatMessageProcessedDocumentPromptTemplatePromptTemplate.auto_gen_description_promptPromptTemplate.auto_gen_document_sample_questions_promptPromptTemplate.auto_gen_document_summary_pre_prompt_summaryPromptTemplate.auto_gen_document_summary_prompt_summaryPromptTemplate.created_atPromptTemplate.default_sample_questionsPromptTemplate.descriptionPromptTemplate.group_countPromptTemplate.hyde_no_rag_llm_prompt_extensionPromptTemplate.idPromptTemplate.image_batch_final_promptPromptTemplate.image_batch_image_promptPromptTemplate.is_defaultPromptTemplate.is_publicPromptTemplate.is_system_defaultPromptTemplate.langPromptTemplate.model_configPromptTemplate.namePromptTemplate.pre_prompt_queryPromptTemplate.pre_prompt_reflectionPromptTemplate.pre_prompt_summaryPromptTemplate.prompt_queryPromptTemplate.prompt_reflectionPromptTemplate.prompt_summaryPromptTemplate.system_promptPromptTemplate.system_prompt_reflectionPromptTemplate.user_countPromptTemplate.user_idPromptTemplate.usernamePromptTemplate.visible
PromptTemplateCountQuestionReplyDataQuestionReplyData.collection_documentsQuestionReplyData.collection_idQuestionReplyData.collection_nameQuestionReplyData.expected_answerQuestionReplyData.include_chat_historyQuestionReplyData.llmQuestionReplyData.model_configQuestionReplyData.pre_prompt_queryQuestionReplyData.pre_prompt_summaryQuestionReplyData.prompt_queryQuestionReplyData.prompt_summaryQuestionReplyData.prompt_template_idQuestionReplyData.question_contentQuestionReplyData.question_idQuestionReplyData.rag_configQuestionReplyData.reply_contentQuestionReplyData.reply_idQuestionReplyData.response_created_at_timeQuestionReplyData.system_promptQuestionReplyData.user_commentQuestionReplyData.votes
QuestionReplyDataCountQueueInfoResultSchedulerStatsSearchResultSearchResultsSessionErrorSharePermissionShareResponseStatusStatusSuggestedQuestionTagUserUserGroupUserJobsUserPermissionUserRoleUserUsageUserWithLLMUsage
- h2ogpte.h2ogpte module
- Module contents
- h2oGPTe - AI for documents and more
H2OGPTEH2OGPTE.add_agent_key()H2OGPTE.add_custom_agent_tool()H2OGPTE.add_role_to_group()H2OGPTE.add_role_to_user()H2OGPTE.add_user_document_permission()H2OGPTE.answer_question()H2OGPTE.archive_collection()H2OGPTE.assign_agent_key_for_tool()H2OGPTE.assign_permissions_to_role()H2OGPTE.bulk_delete_global_configurations()H2OGPTE.bulk_delete_role_configurations()H2OGPTE.bulk_delete_user_configurations_for_user()H2OGPTE.cancel_job()H2OGPTE.cancel_user_job()H2OGPTE.confirm_current_user_deletion()H2OGPTE.count_assets()H2OGPTE.count_chat_sessions()H2OGPTE.count_chat_sessions_for_collection()H2OGPTE.count_collections()H2OGPTE.count_documents()H2OGPTE.count_documents_in_collection()H2OGPTE.count_documents_owned_by_me()H2OGPTE.count_prompt_templates()H2OGPTE.count_question_reply_feedback()H2OGPTE.create_api_key_for_user()H2OGPTE.create_chat_session()H2OGPTE.create_chat_session_on_default_collection()H2OGPTE.create_collection()H2OGPTE.create_extractor()H2OGPTE.create_prompt_template()H2OGPTE.create_secret()H2OGPTE.create_tag()H2OGPTE.create_topic_model()H2OGPTE.create_user_group()H2OGPTE.create_user_role()H2OGPTE.deactivate_api_key()H2OGPTE.delete_agent_directories()H2OGPTE.delete_agent_keys()H2OGPTE.delete_agent_server_files()H2OGPTE.delete_agent_tool_association()H2OGPTE.delete_agent_tool_preference()H2OGPTE.delete_api_keys()H2OGPTE.delete_chat_messages()H2OGPTE.delete_chat_sessions()H2OGPTE.delete_collections()H2OGPTE.delete_collections_as_admin()H2OGPTE.delete_custom_agent_tool()H2OGPTE.delete_document_summaries()H2OGPTE.delete_documents()H2OGPTE.delete_documents_from_collection()H2OGPTE.delete_extractor()H2OGPTE.delete_multiple_agent_directories()H2OGPTE.delete_prompt_templates()H2OGPTE.delete_secret()H2OGPTE.delete_upload()H2OGPTE.delete_user_groups_by_ids()H2OGPTE.delete_user_groups_by_names()H2OGPTE.delete_user_roles_by_ids()H2OGPTE.delete_user_roles_by_names()H2OGPTE.download_document()H2OGPTE.download_reference_highlighting()H2OGPTE.encode_for_retrieval()H2OGPTE.extract_data()H2OGPTE.get_agent_key_tool_associations()H2OGPTE.get_agent_keys()H2OGPTE.get_agent_server_files()H2OGPTE.get_agent_tool_preference()H2OGPTE.get_agent_tools_dict()H2OGPTE.get_all_directory_stats()H2OGPTE.get_chat_session_prompt_template()H2OGPTE.get_chat_session_questions()H2OGPTE.get_chunks()H2OGPTE.get_collection()H2OGPTE.get_collection_for_chat_session()H2OGPTE.get_collection_prompt_template()H2OGPTE.get_collection_questions()H2OGPTE.get_custom_agent_tools()H2OGPTE.get_default_collection()H2OGPTE.get_directory_stats()H2OGPTE.get_document()H2OGPTE.get_document_content()H2OGPTE.get_extractor()H2OGPTE.get_global_configurations()H2OGPTE.get_global_configurations_by_admin()H2OGPTE.get_guardrails_settings()H2OGPTE.get_h2ogpt_system_stats()H2OGPTE.get_job()H2OGPTE.get_llm_and_auto_reasoning_llm_names()H2OGPTE.get_llm_and_auto_vision_llm_names()H2OGPTE.get_llm_name_for_rest()H2OGPTE.get_llm_names()H2OGPTE.get_llm_performance_by_llm()H2OGPTE.get_llm_usage_24h()H2OGPTE.get_llm_usage_24h_by_llm()H2OGPTE.get_llm_usage_24h_with_limits()H2OGPTE.get_llm_usage_6h()H2OGPTE.get_llm_usage_6h_by_llm()H2OGPTE.get_llm_usage_by_llm()H2OGPTE.get_llm_usage_by_llm_and_user()H2OGPTE.get_llm_usage_by_user()H2OGPTE.get_llm_usage_with_limits()H2OGPTE.get_llms()H2OGPTE.get_meta()H2OGPTE.get_prompt_template()H2OGPTE.get_reasoning_capable_llm_names()H2OGPTE.get_scheduler_stats()H2OGPTE.get_secret()H2OGPTE.get_secret_value()H2OGPTE.get_tag()H2OGPTE.get_user_all_agent_directories()H2OGPTE.get_user_configurations()H2OGPTE.get_user_configurations_for_user()H2OGPTE.get_vision_capable_llm_names()H2OGPTE.import_collection_into_collection()H2OGPTE.import_document_into_collection()H2OGPTE.ingest_agent_only_to_standard()H2OGPTE.ingest_from_azure_blob_storage()H2OGPTE.ingest_from_file_system()H2OGPTE.ingest_from_gcs()H2OGPTE.ingest_from_plain_text()H2OGPTE.ingest_from_s3()H2OGPTE.ingest_uploads()H2OGPTE.ingest_website()H2OGPTE.is_collection_permission_granted()H2OGPTE.is_permission_granted()H2OGPTE.list_all_api_keys()H2OGPTE.list_all_collections_sort()H2OGPTE.list_all_jobs()H2OGPTE.list_all_recent_prompt_templates()H2OGPTE.list_all_recent_prompt_templates_sort()H2OGPTE.list_all_tags()H2OGPTE.list_chat_message_meta_part()H2OGPTE.list_chat_message_references()H2OGPTE.list_chat_messages()H2OGPTE.list_chat_messages_full()H2OGPTE.list_chat_sessions_for_collection()H2OGPTE.list_chat_sessions_for_document()H2OGPTE.list_collection_group_permissions()H2OGPTE.list_collection_permissions()H2OGPTE.list_collections_for_document()H2OGPTE.list_document_chunks()H2OGPTE.list_documents_from_tags()H2OGPTE.list_documents_in_collection()H2OGPTE.list_embedding_models()H2OGPTE.list_extractors()H2OGPTE.list_group_permissions()H2OGPTE.list_group_permissions_by_name()H2OGPTE.list_group_roles()H2OGPTE.list_jobs()H2OGPTE.list_list_chat_message_meta()H2OGPTE.list_prompt_group_permissions()H2OGPTE.list_prompt_permissions()H2OGPTE.list_question_reply_feedback_data()H2OGPTE.list_recent_chat_sessions()H2OGPTE.list_recent_collections()H2OGPTE.list_recent_collections_filter()H2OGPTE.list_recent_collections_metadata_filter()H2OGPTE.list_recent_collections_sort()H2OGPTE.list_recent_document_summaries()H2OGPTE.list_recent_documents()H2OGPTE.list_recent_documents_with_summaries()H2OGPTE.list_recent_documents_with_summaries_sort()H2OGPTE.list_recent_prompt_templates()H2OGPTE.list_recent_prompt_templates_sort()H2OGPTE.list_role_configurations()H2OGPTE.list_secret_ids()H2OGPTE.list_system_groups()H2OGPTE.list_system_permissions()H2OGPTE.list_system_roles()H2OGPTE.list_upload()H2OGPTE.list_user_permissions()H2OGPTE.list_user_role_permissions()H2OGPTE.list_user_roles()H2OGPTE.list_users()H2OGPTE.make_collection_private()H2OGPTE.make_collection_public()H2OGPTE.make_prompt_template_private()H2OGPTE.make_prompt_template_public()H2OGPTE.match_chunks()H2OGPTE.process_document()H2OGPTE.remove_collection_expiry_date()H2OGPTE.remove_collection_inactivity_interval()H2OGPTE.remove_collection_size_limit()H2OGPTE.remove_collection_thumbnail()H2OGPTE.remove_role_from_group()H2OGPTE.remove_role_from_user()H2OGPTE.rename_chat_session()H2OGPTE.request_current_user_deletion()H2OGPTE.reset_and_share_prompt_template()H2OGPTE.reset_and_share_prompt_template_with_groups()H2OGPTE.reset_collection_prompt_settings()H2OGPTE.reset_roles_for_group()H2OGPTE.reset_roles_for_user()H2OGPTE.reset_user_configurations_for_user()H2OGPTE.run_selftest()H2OGPTE.search_chunks()H2OGPTE.set_api_key_expiration()H2OGPTE.set_chat_message_votes()H2OGPTE.set_chat_session_collection()H2OGPTE.set_chat_session_prompt_template()H2OGPTE.set_collection_expiry_date()H2OGPTE.set_collection_inactivity_interval()H2OGPTE.set_collection_prompt_template()H2OGPTE.set_collection_size_limit()H2OGPTE.set_collection_thumbnail()H2OGPTE.set_default_prompt_template_visibility()H2OGPTE.set_global_configuration()H2OGPTE.set_role_configuration()H2OGPTE.set_role_priority()H2OGPTE.set_user_configuration_for_user()H2OGPTE.share_chat_session()H2OGPTE.share_collection()H2OGPTE.share_collection_with_group()H2OGPTE.share_prompt()H2OGPTE.share_prompt_with_group()H2OGPTE.summarize_content()H2OGPTE.summarize_document()H2OGPTE.tag_document()H2OGPTE.unarchive_collection()H2OGPTE.unshare_collection()H2OGPTE.unshare_collection_for_all()H2OGPTE.unshare_collection_from_group()H2OGPTE.unshare_prompt()H2OGPTE.unshare_prompt_for_all()H2OGPTE.unshare_prompt_from_group()H2OGPTE.untag_document()H2OGPTE.update_agent_key()H2OGPTE.update_agent_tool_preference()H2OGPTE.update_collection()H2OGPTE.update_collection_metadata()H2OGPTE.update_collection_rag_type()H2OGPTE.update_collection_settings()H2OGPTE.update_custom_agent_tool()H2OGPTE.update_document_metadata()H2OGPTE.update_document_name()H2OGPTE.update_document_uri()H2OGPTE.update_prompt_template()H2OGPTE.update_question_reply_feedback()H2OGPTE.update_secret()H2OGPTE.update_tag()H2OGPTE.upload()
H2OGPTEAsyncH2OGPTEAsync.INITIAL_WAIT_INTERVALH2OGPTEAsync.MAX_WAIT_INTERVALH2OGPTEAsync.TIMEOUTH2OGPTEAsync.WAIT_BACKOFF_FACTORH2OGPTEAsync.add_agent_key()H2OGPTEAsync.add_custom_agent_tool()H2OGPTEAsync.add_role_to_group()H2OGPTEAsync.add_role_to_user()H2OGPTEAsync.add_user_document_permission()H2OGPTEAsync.answer_question()H2OGPTEAsync.archive_collection()H2OGPTEAsync.assign_agent_key_for_tool()H2OGPTEAsync.assign_permissions_to_role()H2OGPTEAsync.bulk_delete_global_configurations()H2OGPTEAsync.bulk_delete_role_configurations()H2OGPTEAsync.bulk_delete_user_configurations_for_user()H2OGPTEAsync.cancel_job()H2OGPTEAsync.cancel_user_job()H2OGPTEAsync.close()H2OGPTEAsync.confirm_current_user_deletion()H2OGPTEAsync.connect()H2OGPTEAsync.count_assets()H2OGPTEAsync.count_chat_sessions()H2OGPTEAsync.count_chat_sessions_for_collection()H2OGPTEAsync.count_collections()H2OGPTEAsync.count_documents()H2OGPTEAsync.count_documents_in_collection()H2OGPTEAsync.count_documents_owned_by_me()H2OGPTEAsync.count_prompt_templates()H2OGPTEAsync.count_question_reply_feedback()H2OGPTEAsync.create_api_key_for_user()H2OGPTEAsync.create_chat_session()H2OGPTEAsync.create_chat_session_on_default_collection()H2OGPTEAsync.create_collection()H2OGPTEAsync.create_extractor()H2OGPTEAsync.create_prompt_template()H2OGPTEAsync.create_secret()H2OGPTEAsync.create_tag()H2OGPTEAsync.create_topic_model()H2OGPTEAsync.create_user_group()H2OGPTEAsync.create_user_role()H2OGPTEAsync.deactivate_api_key()H2OGPTEAsync.delete_agent_directories()H2OGPTEAsync.delete_agent_keys()H2OGPTEAsync.delete_agent_server_files()H2OGPTEAsync.delete_agent_tool_association()H2OGPTEAsync.delete_agent_tool_preference()H2OGPTEAsync.delete_api_keys()H2OGPTEAsync.delete_chat_messages()H2OGPTEAsync.delete_chat_sessions()H2OGPTEAsync.delete_collections()H2OGPTEAsync.delete_collections_as_admin()H2OGPTEAsync.delete_custom_agent_tool()H2OGPTEAsync.delete_document_summaries()H2OGPTEAsync.delete_documents()H2OGPTEAsync.delete_documents_from_collection()H2OGPTEAsync.delete_extractor()H2OGPTEAsync.delete_multiple_agent_directories()H2OGPTEAsync.delete_prompt_templates()H2OGPTEAsync.delete_secret()H2OGPTEAsync.delete_upload()H2OGPTEAsync.delete_user_groups_by_ids()H2OGPTEAsync.delete_user_groups_by_names()H2OGPTEAsync.delete_user_roles_by_ids()H2OGPTEAsync.delete_user_roles_by_names()H2OGPTEAsync.download_document()H2OGPTEAsync.download_reference_highlighting()H2OGPTEAsync.encode_for_retrieval()H2OGPTEAsync.extract_data()H2OGPTEAsync.get_agent_key_tool_associations()H2OGPTEAsync.get_agent_keys()H2OGPTEAsync.get_agent_server_files()H2OGPTEAsync.get_agent_tool_preference()H2OGPTEAsync.get_agent_tools_dict()H2OGPTEAsync.get_all_directory_stats()H2OGPTEAsync.get_chat_session_prompt_template()H2OGPTEAsync.get_chat_session_questions()H2OGPTEAsync.get_chunks()H2OGPTEAsync.get_collection()H2OGPTEAsync.get_collection_for_chat_session()H2OGPTEAsync.get_collection_prompt_template()H2OGPTEAsync.get_collection_questions()H2OGPTEAsync.get_custom_agent_tools()H2OGPTEAsync.get_default_collection()H2OGPTEAsync.get_directory_stats()H2OGPTEAsync.get_document()H2OGPTEAsync.get_document_content()H2OGPTEAsync.get_extractor()H2OGPTEAsync.get_global_configurations()H2OGPTEAsync.get_global_configurations_by_admin()H2OGPTEAsync.get_guardrails_settings()H2OGPTEAsync.get_h2ogpt_system_stats()H2OGPTEAsync.get_job()H2OGPTEAsync.get_llm_and_auto_reasoning_llm_names()H2OGPTEAsync.get_llm_and_auto_vision_llm_names()H2OGPTEAsync.get_llm_name_for_rest()H2OGPTEAsync.get_llm_names()H2OGPTEAsync.get_llm_performance_by_llm()H2OGPTEAsync.get_llm_usage_24h()H2OGPTEAsync.get_llm_usage_24h_by_llm()H2OGPTEAsync.get_llm_usage_24h_with_limits()H2OGPTEAsync.get_llm_usage_6h()H2OGPTEAsync.get_llm_usage_6h_by_llm()H2OGPTEAsync.get_llm_usage_by_llm()H2OGPTEAsync.get_llm_usage_by_llm_and_user()H2OGPTEAsync.get_llm_usage_by_user()H2OGPTEAsync.get_llm_usage_with_limits()H2OGPTEAsync.get_llms()H2OGPTEAsync.get_meta()H2OGPTEAsync.get_prompt_template()H2OGPTEAsync.get_reasoning_capable_llm_names()H2OGPTEAsync.get_scheduler_stats()H2OGPTEAsync.get_secret()H2OGPTEAsync.get_secret_value()H2OGPTEAsync.get_tag()H2OGPTEAsync.get_user_all_agent_directories()H2OGPTEAsync.get_user_configurations()H2OGPTEAsync.get_user_configurations_for_user()H2OGPTEAsync.get_vision_capable_llm_names()H2OGPTEAsync.import_collection_into_collection()H2OGPTEAsync.import_document_into_collection()H2OGPTEAsync.ingest_agent_only_to_standard()H2OGPTEAsync.ingest_from_azure_blob_storage()H2OGPTEAsync.ingest_from_file_system()H2OGPTEAsync.ingest_from_gcs()H2OGPTEAsync.ingest_from_plain_text()H2OGPTEAsync.ingest_from_s3()H2OGPTEAsync.ingest_uploads()H2OGPTEAsync.ingest_website()H2OGPTEAsync.is_collection_permission_granted()H2OGPTEAsync.is_permission_granted()H2OGPTEAsync.list_all_api_keys()H2OGPTEAsync.list_all_collections_sort()H2OGPTEAsync.list_all_jobs()H2OGPTEAsync.list_all_recent_prompt_templates()H2OGPTEAsync.list_all_recent_prompt_templates_sort()H2OGPTEAsync.list_all_tags()H2OGPTEAsync.list_chat_message_meta_part()H2OGPTEAsync.list_chat_message_references()H2OGPTEAsync.list_chat_messages()H2OGPTEAsync.list_chat_messages_full()H2OGPTEAsync.list_chat_sessions_for_collection()H2OGPTEAsync.list_chat_sessions_for_document()H2OGPTEAsync.list_collection_group_permissions()H2OGPTEAsync.list_collection_permissions()H2OGPTEAsync.list_collections_for_document()H2OGPTEAsync.list_document_chunks()H2OGPTEAsync.list_documents_from_tags()H2OGPTEAsync.list_documents_in_collection()H2OGPTEAsync.list_embedding_models()H2OGPTEAsync.list_extractors()H2OGPTEAsync.list_group_permissions()H2OGPTEAsync.list_group_permissions_by_name()H2OGPTEAsync.list_group_roles()H2OGPTEAsync.list_jobs()H2OGPTEAsync.list_list_chat_message_meta()H2OGPTEAsync.list_prompt_group_permissions()H2OGPTEAsync.list_prompt_permissions()H2OGPTEAsync.list_question_reply_feedback_data()H2OGPTEAsync.list_recent_chat_sessions()H2OGPTEAsync.list_recent_collections()H2OGPTEAsync.list_recent_collections_filter()H2OGPTEAsync.list_recent_collections_metadata_filter()H2OGPTEAsync.list_recent_collections_sort()H2OGPTEAsync.list_recent_document_summaries()H2OGPTEAsync.list_recent_documents()H2OGPTEAsync.list_recent_documents_with_summaries()H2OGPTEAsync.list_recent_documents_with_summaries_sort()H2OGPTEAsync.list_recent_prompt_templates()H2OGPTEAsync.list_recent_prompt_templates_sort()H2OGPTEAsync.list_role_configurations()H2OGPTEAsync.list_secret_ids()H2OGPTEAsync.list_system_groups()H2OGPTEAsync.list_system_permissions()H2OGPTEAsync.list_system_roles()H2OGPTEAsync.list_upload()H2OGPTEAsync.list_user_permissions()H2OGPTEAsync.list_user_role_permissions()H2OGPTEAsync.list_user_roles()H2OGPTEAsync.list_users()H2OGPTEAsync.make_collection_private()H2OGPTEAsync.make_collection_public()H2OGPTEAsync.make_prompt_template_private()H2OGPTEAsync.make_prompt_template_public()H2OGPTEAsync.match_chunks()H2OGPTEAsync.process_document()H2OGPTEAsync.remove_collection_expiry_date()H2OGPTEAsync.remove_collection_inactivity_interval()H2OGPTEAsync.remove_collection_size_limit()H2OGPTEAsync.remove_collection_thumbnail()H2OGPTEAsync.remove_role_from_group()H2OGPTEAsync.remove_role_from_user()H2OGPTEAsync.rename_chat_session()H2OGPTEAsync.request_current_user_deletion()H2OGPTEAsync.reset_and_share_prompt_template()H2OGPTEAsync.reset_and_share_prompt_template_with_groups()H2OGPTEAsync.reset_collection_prompt_settings()H2OGPTEAsync.reset_roles_for_group()H2OGPTEAsync.reset_roles_for_user()H2OGPTEAsync.reset_user_configurations_for_user()H2OGPTEAsync.run_selftest()H2OGPTEAsync.search_chunks()H2OGPTEAsync.set_api_key_expiration()H2OGPTEAsync.set_chat_message_votes()H2OGPTEAsync.set_chat_session_collection()H2OGPTEAsync.set_chat_session_prompt_template()H2OGPTEAsync.set_collection_expiry_date()H2OGPTEAsync.set_collection_inactivity_interval()H2OGPTEAsync.set_collection_prompt_template()H2OGPTEAsync.set_collection_size_limit()H2OGPTEAsync.set_collection_thumbnail()H2OGPTEAsync.set_default_prompt_template_visibility()H2OGPTEAsync.set_global_configuration()H2OGPTEAsync.set_role_configuration()H2OGPTEAsync.set_role_priority()H2OGPTEAsync.set_user_configuration_for_user()H2OGPTEAsync.share_chat_session()H2OGPTEAsync.share_collection()H2OGPTEAsync.share_collection_with_group()H2OGPTEAsync.share_prompt()H2OGPTEAsync.share_prompt_with_group()H2OGPTEAsync.summarize_content()H2OGPTEAsync.summarize_document()H2OGPTEAsync.tag_document()H2OGPTEAsync.unarchive_collection()H2OGPTEAsync.unshare_collection()H2OGPTEAsync.unshare_collection_for_all()H2OGPTEAsync.unshare_collection_from_group()H2OGPTEAsync.unshare_prompt()H2OGPTEAsync.unshare_prompt_for_all()H2OGPTEAsync.unshare_prompt_from_group()H2OGPTEAsync.untag_document()H2OGPTEAsync.update_agent_key()H2OGPTEAsync.update_agent_tool_preference()H2OGPTEAsync.update_collection()H2OGPTEAsync.update_collection_metadata()H2OGPTEAsync.update_collection_rag_type()H2OGPTEAsync.update_collection_settings()H2OGPTEAsync.update_custom_agent_tool()H2OGPTEAsync.update_document_metadata()H2OGPTEAsync.update_document_name()H2OGPTEAsync.update_document_uri()H2OGPTEAsync.update_prompt_template()H2OGPTEAsync.update_question_reply_feedback()H2OGPTEAsync.update_secret()H2OGPTEAsync.update_tag()H2OGPTEAsync.upload()
SessionSessionAsync
- Submodules
- Indices and Tables
- h2ogpte package
Python for REST API
Third-Party Notices
Release Notes