h2oGPTE Python API
h2oGPTe Python client API reference.
Python API
- h2ogpte package
- Submodules
- h2ogpte.h2ogpte module
H2OGPTEH2OGPTE.INITIAL_WAIT_INTERVALH2OGPTE.MAX_WAIT_INTERVALH2OGPTE.TIMEOUTH2OGPTE.WAIT_BACKOFF_FACTORH2OGPTE.answer_question()H2OGPTE.cancel_job()H2OGPTE.connect()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_chat_session()H2OGPTE.create_chat_session_on_default_collection()H2OGPTE.create_collection()H2OGPTE.create_prompt_template()H2OGPTE.delete_chat_messages()H2OGPTE.delete_chat_sessions()H2OGPTE.delete_collections()H2OGPTE.delete_document_summaries()H2OGPTE.delete_documents()H2OGPTE.delete_documents_from_collection()H2OGPTE.delete_prompt_templates()H2OGPTE.delete_upload()H2OGPTE.download_document()H2OGPTE.encode_for_retrieval()H2OGPTE.extract_data()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_default_collection()H2OGPTE.get_document()H2OGPTE.get_job()H2OGPTE.get_llm_names()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_with_limits()H2OGPTE.get_llms()H2OGPTE.get_meta()H2OGPTE.get_prompt_template()H2OGPTE.get_scheduler_stats()H2OGPTE.import_collection_into_collection()H2OGPTE.import_document_into_collection()H2OGPTE.ingest_from_file_system()H2OGPTE.ingest_uploads()H2OGPTE.ingest_website()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_collection_permissions()H2OGPTE.list_collections_for_document()H2OGPTE.list_documents_in_collection()H2OGPTE.list_embedding_models()H2OGPTE.list_jobs()H2OGPTE.list_list_chat_message_meta()H2OGPTE.list_question_reply_feedback_data()H2OGPTE.list_recent_chat_sessions()H2OGPTE.list_recent_collections()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_upload()H2OGPTE.list_users()H2OGPTE.make_collection_private()H2OGPTE.make_collection_public()H2OGPTE.match_chunks()H2OGPTE.reset_collection_prompt_settings()H2OGPTE.search_chunks()H2OGPTE.set_chat_message_votes()H2OGPTE.set_chat_session_prompt_template()H2OGPTE.set_collection_prompt_template()H2OGPTE.share_collection()H2OGPTE.summarize_content()H2OGPTE.summarize_document()H2OGPTE.unshare_collection()H2OGPTE.unshare_collection_for_all()H2OGPTE.update_collection()H2OGPTE.update_collection_rag_type()H2OGPTE.update_prompt_template()H2OGPTE.upload()
marshal()unmarshal()
- h2ogpte.session module
- h2ogpte.types module
AnswerChatAcknowledgementChatMessageChatMessageFullChatMessageMetaChatMessageReferenceChatRequestChatRequest.bodyChatRequest.correlation_idChatRequest.llmChatRequest.llm_argsChatRequest.modeChatRequest.pre_prompt_queryChatRequest.pre_prompt_summaryChatRequest.prompt_queryChatRequest.prompt_summaryChatRequest.rag_configChatRequest.self_reflection_configChatRequest.session_idChatRequest.system_promptChatRequest.t
ChatResponseChatSessionCountChatSessionForCollectionChatSessionInfoChunkChunksCollectionCollection.created_atCollection.descriptionCollection.document_countCollection.document_sizeCollection.embedding_modelCollection.idCollection.is_publicCollection.model_configCollection.model_fieldsCollection.nameCollection.prompt_template_idCollection.rag_typeCollection.updated_atCollection.username
CollectionCountCollectionInfoCollectionInfo.descriptionCollectionInfo.document_countCollectionInfo.document_sizeCollectionInfo.idCollectionInfo.is_publicCollectionInfo.model_configCollectionInfo.model_fieldsCollectionInfo.nameCollectionInfo.sessions_countCollectionInfo.updated_atCollectionInfo.user_countCollectionInfo.username
ConfigItemDocumentDocumentCountDocumentInfoDocumentInfoSummaryDocumentInfoSummary.idDocumentInfoSummary.model_configDocumentInfoSummary.model_fieldsDocumentInfoSummary.nameDocumentInfoSummary.page_countDocumentInfoSummary.sizeDocumentInfoSummary.statusDocumentInfoSummary.summaryDocumentInfoSummary.summary_parametersDocumentInfoSummary.typeDocumentInfoSummary.updated_atDocumentInfoSummary.usage_statsDocumentInfoSummary.username
DocumentSummaryExtractionAnswerIdentifierInvalidArgumentErrorJobJobKindJobKind.DeleteCollectionsJobJobKind.DeleteDocumentsFromCollectionJobJobKind.DeleteDocumentsJobJobKind.DocumentSummaryJobJobKind.ImportCollectionIntoCollectionJobJobKind.ImportDocumentIntoCollectionJobJobKind.IndexFilesJobJobKind.IngestFromFileSystemJobJobKind.IngestUploadsJobJobKind.IngestWebsiteJobJobKind.NoOpJobJobKind.UpdateCollectionStatsJob
JobStatusLLMUsageLLMUsageLimitMetaObjectCountObjectNotFoundErrorPartialChatMessagePermissionPromptTemplatePromptTemplate.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.hyde_no_rag_llm_prompt_extensionPromptTemplate.idPromptTemplate.is_defaultPromptTemplate.langPromptTemplate.model_configPromptTemplate.model_fieldsPromptTemplate.namePromptTemplate.pre_prompt_queryPromptTemplate.pre_prompt_reflectionPromptTemplate.pre_prompt_summaryPromptTemplate.prompt_queryPromptTemplate.prompt_reflectionPromptTemplate.prompt_summaryPromptTemplate.system_promptPromptTemplate.system_prompt_reflection
PromptTemplateCountQuestionReplyDataQuestionReplyData.collection_documentsQuestionReplyData.collection_idQuestionReplyData.collection_nameQuestionReplyData.expected_answerQuestionReplyData.llmQuestionReplyData.model_configQuestionReplyData.model_fieldsQuestionReplyData.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
QuestionReplyDataCountResultSchedulerStatsSearchResultSearchResultsSessionErrorShareResponseStatusStatusSuggestedQuestionUnauthorizedErrorUser
- h2ogpte.h2ogpte module
- Module contents
- h2oGPTe - AI for documents and more
H2OGPTEH2OGPTE.INITIAL_WAIT_INTERVALH2OGPTE.MAX_WAIT_INTERVALH2OGPTE.TIMEOUTH2OGPTE.WAIT_BACKOFF_FACTORH2OGPTE.answer_question()H2OGPTE.cancel_job()H2OGPTE.connect()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_chat_session()H2OGPTE.create_chat_session_on_default_collection()H2OGPTE.create_collection()H2OGPTE.create_prompt_template()H2OGPTE.delete_chat_messages()H2OGPTE.delete_chat_sessions()H2OGPTE.delete_collections()H2OGPTE.delete_document_summaries()H2OGPTE.delete_documents()H2OGPTE.delete_documents_from_collection()H2OGPTE.delete_prompt_templates()H2OGPTE.delete_upload()H2OGPTE.download_document()H2OGPTE.encode_for_retrieval()H2OGPTE.extract_data()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_default_collection()H2OGPTE.get_document()H2OGPTE.get_job()H2OGPTE.get_llm_names()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_with_limits()H2OGPTE.get_llms()H2OGPTE.get_meta()H2OGPTE.get_prompt_template()H2OGPTE.get_scheduler_stats()H2OGPTE.import_collection_into_collection()H2OGPTE.import_document_into_collection()H2OGPTE.ingest_from_file_system()H2OGPTE.ingest_uploads()H2OGPTE.ingest_website()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_collection_permissions()H2OGPTE.list_collections_for_document()H2OGPTE.list_documents_in_collection()H2OGPTE.list_embedding_models()H2OGPTE.list_jobs()H2OGPTE.list_list_chat_message_meta()H2OGPTE.list_question_reply_feedback_data()H2OGPTE.list_recent_chat_sessions()H2OGPTE.list_recent_collections()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_upload()H2OGPTE.list_users()H2OGPTE.make_collection_private()H2OGPTE.make_collection_public()H2OGPTE.match_chunks()H2OGPTE.reset_collection_prompt_settings()H2OGPTE.search_chunks()H2OGPTE.set_chat_message_votes()H2OGPTE.set_chat_session_prompt_template()H2OGPTE.set_collection_prompt_template()H2OGPTE.share_collection()H2OGPTE.summarize_content()H2OGPTE.summarize_document()H2OGPTE.unshare_collection()H2OGPTE.unshare_collection_for_all()H2OGPTE.update_collection()H2OGPTE.update_collection_rag_type()H2OGPTE.update_prompt_template()H2OGPTE.upload()
H2OGPTEAsyncH2OGPTEAsync.INITIAL_WAIT_INTERVALH2OGPTEAsync.MAX_WAIT_INTERVALH2OGPTEAsync.TIMEOUTH2OGPTEAsync.WAIT_BACKOFF_FACTORH2OGPTEAsync.answer_question()H2OGPTEAsync.cancel_job()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_chat_session()H2OGPTEAsync.create_chat_session_on_default_collection()H2OGPTEAsync.create_collection()H2OGPTEAsync.create_prompt_template()H2OGPTEAsync.delete_chat_messages()H2OGPTEAsync.delete_chat_sessions()H2OGPTEAsync.delete_collections()H2OGPTEAsync.delete_document_summaries()H2OGPTEAsync.delete_documents()H2OGPTEAsync.delete_documents_from_collection()H2OGPTEAsync.delete_prompt_templates()H2OGPTEAsync.delete_upload()H2OGPTEAsync.download_document()H2OGPTEAsync.encode_for_retrieval()H2OGPTEAsync.extract_data()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_default_collection()H2OGPTEAsync.get_document()H2OGPTEAsync.get_job()H2OGPTEAsync.get_llm_names()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_with_limits()H2OGPTEAsync.get_llms()H2OGPTEAsync.get_meta()H2OGPTEAsync.get_prompt_template()H2OGPTEAsync.get_scheduler_stats()H2OGPTEAsync.import_collection_into_collection()H2OGPTEAsync.import_document_into_collection()H2OGPTEAsync.ingest_from_file_system()H2OGPTEAsync.ingest_uploads()H2OGPTEAsync.ingest_website()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_collection_permissions()H2OGPTEAsync.list_collections_for_document()H2OGPTEAsync.list_documents_in_collection()H2OGPTEAsync.list_embedding_models()H2OGPTEAsync.list_jobs()H2OGPTEAsync.list_list_chat_message_meta()H2OGPTEAsync.list_question_reply_feedback_data()H2OGPTEAsync.list_recent_chat_sessions()H2OGPTEAsync.list_recent_collections()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_upload()H2OGPTEAsync.list_users()H2OGPTEAsync.make_collection_private()H2OGPTEAsync.make_collection_public()H2OGPTEAsync.match_chunks()H2OGPTEAsync.reset_collection_prompt_settings()H2OGPTEAsync.search_chunks()H2OGPTEAsync.set_chat_message_votes()H2OGPTEAsync.set_chat_session_prompt_template()H2OGPTEAsync.set_collection_prompt_template()H2OGPTEAsync.share_collection()H2OGPTEAsync.summarize_content()H2OGPTEAsync.summarize_document()H2OGPTEAsync.unshare_collection()H2OGPTEAsync.unshare_collection_for_all()H2OGPTEAsync.update_collection()H2OGPTEAsync.update_collection_rag_type()H2OGPTEAsync.update_prompt_template()H2OGPTEAsync.upload()
SessionSessionAsync
- Submodules