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.
- h2oGPTE Python API
- h2ogpte package
- Submodules
- h2ogpte.h2ogpte module
H2OGPTE
H2OGPTE.INITIAL_WAIT_INTERVAL
H2OGPTE.MAX_WAIT_INTERVAL
H2OGPTE.TIMEOUT
H2OGPTE.WAIT_BACKOFF_FACTOR
H2OGPTE.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.create_tag()
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.download_reference_highlighting()
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_guardrails_settings()
H2OGPTE.get_job()
H2OGPTE.get_llm_and_auto_vision_llm_names()
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_with_limits()
H2OGPTE.get_llms()
H2OGPTE.get_meta()
H2OGPTE.get_prompt_template()
H2OGPTE.get_scheduler_stats()
H2OGPTE.get_tag()
H2OGPTE.get_vision_capable_llm_names()
H2OGPTE.import_collection_into_collection()
H2OGPTE.import_document_into_collection()
H2OGPTE.ingest_from_azure_blob_storage()
H2OGPTE.ingest_from_file_system()
H2OGPTE.ingest_from_gcs()
H2OGPTE.ingest_from_s3()
H2OGPTE.ingest_uploads()
H2OGPTE.ingest_website()
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_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_jobs()
H2OGPTE.list_list_chat_message_meta()
H2OGPTE.list_prompt_permissions()
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.process_document()
H2OGPTE.reset_collection_prompt_settings()
H2OGPTE.run_selftest()
H2OGPTE.search_chunks()
H2OGPTE.set_chat_message_votes()
H2OGPTE.set_chat_session_collection()
H2OGPTE.set_chat_session_prompt_template()
H2OGPTE.set_collection_prompt_template()
H2OGPTE.share_collection()
H2OGPTE.share_prompt()
H2OGPTE.summarize_content()
H2OGPTE.summarize_document()
H2OGPTE.tag_document()
H2OGPTE.unshare_collection()
H2OGPTE.unshare_collection_for_all()
H2OGPTE.unshare_prompt()
H2OGPTE.unshare_prompt_for_all()
H2OGPTE.untag_document()
H2OGPTE.update_collection()
H2OGPTE.update_collection_rag_type()
H2OGPTE.update_prompt_template()
H2OGPTE.update_question_reply_feedback()
H2OGPTE.update_tag()
H2OGPTE.upload()
marshal()
unmarshal()
unmarshal_dict()
- h2ogpte.session module
- h2ogpte.types module
Answer
ChatAcknowledgement
ChatMessage
ChatMessageFull
ChatMessageFull.content
ChatMessageFull.created_at
ChatMessageFull.error
ChatMessageFull.has_references
ChatMessageFull.id
ChatMessageFull.model_config
ChatMessageFull.model_fields
ChatMessageFull.reply_to
ChatMessageFull.total_references
ChatMessageFull.type_list
ChatMessageFull.username
ChatMessageFull.votes
ChatMessageMeta
ChatMessageReference
ChatRequest
ChatRequest.body
ChatRequest.correlation_id
ChatRequest.image_batch_final_prompt
ChatRequest.image_batch_image_prompt
ChatRequest.include_chat_history
ChatRequest.llm
ChatRequest.llm_args
ChatRequest.mode
ChatRequest.pre_prompt_query
ChatRequest.pre_prompt_summary
ChatRequest.prompt_query
ChatRequest.prompt_summary
ChatRequest.rag_config
ChatRequest.self_reflection_config
ChatRequest.session_id
ChatRequest.system_prompt
ChatRequest.t
ChatRequest.tags
ChatResponse
ChatSessionCount
ChatSessionForCollection
ChatSessionInfo
Chunk
Chunks
Collection
Collection.collection_settings
Collection.created_at
Collection.description
Collection.document_count
Collection.document_size
Collection.embedding_model
Collection.id
Collection.is_public
Collection.model_config
Collection.model_fields
Collection.name
Collection.prompt_template_id
Collection.rag_type
Collection.updated_at
Collection.username
CollectionCount
CollectionInfo
CollectionInfo.description
CollectionInfo.document_count
CollectionInfo.document_size
CollectionInfo.id
CollectionInfo.is_public
CollectionInfo.model_config
CollectionInfo.model_fields
CollectionInfo.name
CollectionInfo.sessions_count
CollectionInfo.updated_at
CollectionInfo.user_count
CollectionInfo.username
ConfigItem
Document
Document.connector
Document.created_at
Document.guardrails_settings
Document.id
Document.meta_data_dict
Document.model_config
Document.model_fields
Document.name
Document.original_mtime
Document.original_type
Document.page_count
Document.size
Document.status
Document.type
Document.updated_at
Document.uri
DocumentCount
DocumentInfo
DocumentInfo.connector
DocumentInfo.guardrails_settings
DocumentInfo.id
DocumentInfo.meta_data_dict
DocumentInfo.model_config
DocumentInfo.model_fields
DocumentInfo.name
DocumentInfo.original_type
DocumentInfo.page_count
DocumentInfo.size
DocumentInfo.status
DocumentInfo.type
DocumentInfo.updated_at
DocumentInfo.uri
DocumentInfo.username
DocumentInfoSummary
DocumentInfoSummary.connector
DocumentInfoSummary.guardrails_settings
DocumentInfoSummary.id
DocumentInfoSummary.meta_data_dict
DocumentInfoSummary.model_config
DocumentInfoSummary.model_fields
DocumentInfoSummary.name
DocumentInfoSummary.original_type
DocumentInfoSummary.page_count
DocumentInfoSummary.size
DocumentInfoSummary.status
DocumentInfoSummary.summary
DocumentInfoSummary.summary_parameters
DocumentInfoSummary.type
DocumentInfoSummary.updated_at
DocumentInfoSummary.uri
DocumentInfoSummary.usage_stats
DocumentInfoSummary.username
DocumentSummary
ExtractionAnswer
Identifier
InvalidArgumentError
Job
JobKind
JobKind.DeleteCollectionsJob
JobKind.DeleteDocumentsFromCollectionJob
JobKind.DeleteDocumentsJob
JobKind.DocumentSummaryJob
JobKind.ImportCollectionIntoCollectionJob
JobKind.ImportDocumentIntoCollectionJob
JobKind.IndexFilesJob
JobKind.IngestFromCloudStorageJob
JobKind.IngestFromFileSystemJob
JobKind.IngestUploadsJob
JobKind.IngestWebsiteJob
JobKind.NoOpJob
JobKind.UpdateCollectionStatsJob
JobStatus
LLMPerformance
LLMUsage
LLMUsageLimit
Meta
ObjectCount
ObjectNotFoundError
PartialChatMessage
Permission
ProcessedDocument
PromptTemplate
PromptTemplate.auto_gen_description_prompt
PromptTemplate.auto_gen_document_sample_questions_prompt
PromptTemplate.auto_gen_document_summary_pre_prompt_summary
PromptTemplate.auto_gen_document_summary_prompt_summary
PromptTemplate.created_at
PromptTemplate.default_sample_questions
PromptTemplate.description
PromptTemplate.hyde_no_rag_llm_prompt_extension
PromptTemplate.id
PromptTemplate.image_batch_final_prompt
PromptTemplate.image_batch_image_prompt
PromptTemplate.is_default
PromptTemplate.lang
PromptTemplate.model_config
PromptTemplate.model_fields
PromptTemplate.name
PromptTemplate.pre_prompt_query
PromptTemplate.pre_prompt_reflection
PromptTemplate.pre_prompt_summary
PromptTemplate.prompt_query
PromptTemplate.prompt_reflection
PromptTemplate.prompt_summary
PromptTemplate.system_prompt
PromptTemplate.system_prompt_reflection
PromptTemplate.user_count
PromptTemplate.user_id
PromptTemplate.username
PromptTemplateCount
QuestionReplyData
QuestionReplyData.collection_documents
QuestionReplyData.collection_id
QuestionReplyData.collection_name
QuestionReplyData.expected_answer
QuestionReplyData.include_chat_history
QuestionReplyData.llm
QuestionReplyData.model_config
QuestionReplyData.model_fields
QuestionReplyData.pre_prompt_query
QuestionReplyData.pre_prompt_summary
QuestionReplyData.prompt_query
QuestionReplyData.prompt_summary
QuestionReplyData.prompt_template_id
QuestionReplyData.question_content
QuestionReplyData.question_id
QuestionReplyData.rag_config
QuestionReplyData.reply_content
QuestionReplyData.reply_id
QuestionReplyData.response_created_at_time
QuestionReplyData.system_prompt
QuestionReplyData.user_comment
QuestionReplyData.votes
QuestionReplyDataCount
Result
SchedulerStats
SearchResult
SearchResults
SessionError
ShareResponseStatus
Status
SuggestedQuestion
Tag
UnauthorizedError
User
- h2ogpte.h2ogpte module
- Module contents
- h2oGPTe - AI for documents and more
H2OGPTE
H2OGPTE.INITIAL_WAIT_INTERVAL
H2OGPTE.MAX_WAIT_INTERVAL
H2OGPTE.TIMEOUT
H2OGPTE.WAIT_BACKOFF_FACTOR
H2OGPTE.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.create_tag()
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.download_reference_highlighting()
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_guardrails_settings()
H2OGPTE.get_job()
H2OGPTE.get_llm_and_auto_vision_llm_names()
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_with_limits()
H2OGPTE.get_llms()
H2OGPTE.get_meta()
H2OGPTE.get_prompt_template()
H2OGPTE.get_scheduler_stats()
H2OGPTE.get_tag()
H2OGPTE.get_vision_capable_llm_names()
H2OGPTE.import_collection_into_collection()
H2OGPTE.import_document_into_collection()
H2OGPTE.ingest_from_azure_blob_storage()
H2OGPTE.ingest_from_file_system()
H2OGPTE.ingest_from_gcs()
H2OGPTE.ingest_from_s3()
H2OGPTE.ingest_uploads()
H2OGPTE.ingest_website()
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_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_jobs()
H2OGPTE.list_list_chat_message_meta()
H2OGPTE.list_prompt_permissions()
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.process_document()
H2OGPTE.reset_collection_prompt_settings()
H2OGPTE.run_selftest()
H2OGPTE.search_chunks()
H2OGPTE.set_chat_message_votes()
H2OGPTE.set_chat_session_collection()
H2OGPTE.set_chat_session_prompt_template()
H2OGPTE.set_collection_prompt_template()
H2OGPTE.share_collection()
H2OGPTE.share_prompt()
H2OGPTE.summarize_content()
H2OGPTE.summarize_document()
H2OGPTE.tag_document()
H2OGPTE.unshare_collection()
H2OGPTE.unshare_collection_for_all()
H2OGPTE.unshare_prompt()
H2OGPTE.unshare_prompt_for_all()
H2OGPTE.untag_document()
H2OGPTE.update_collection()
H2OGPTE.update_collection_rag_type()
H2OGPTE.update_prompt_template()
H2OGPTE.update_question_reply_feedback()
H2OGPTE.update_tag()
H2OGPTE.upload()
H2OGPTEAsync
H2OGPTEAsync.INITIAL_WAIT_INTERVAL
H2OGPTEAsync.MAX_WAIT_INTERVAL
H2OGPTEAsync.TIMEOUT
H2OGPTEAsync.WAIT_BACKOFF_FACTOR
H2OGPTEAsync.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.create_tag()
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.download_reference_highlighting()
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_guardrails_settings()
H2OGPTEAsync.get_job()
H2OGPTEAsync.get_llm_and_auto_vision_llm_names()
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_with_limits()
H2OGPTEAsync.get_llms()
H2OGPTEAsync.get_meta()
H2OGPTEAsync.get_prompt_template()
H2OGPTEAsync.get_scheduler_stats()
H2OGPTEAsync.get_tag()
H2OGPTEAsync.get_vision_capable_llm_names()
H2OGPTEAsync.import_collection_into_collection()
H2OGPTEAsync.import_document_into_collection()
H2OGPTEAsync.ingest_from_azure_blob_storage()
H2OGPTEAsync.ingest_from_file_system()
H2OGPTEAsync.ingest_from_gcs()
H2OGPTEAsync.ingest_from_s3()
H2OGPTEAsync.ingest_uploads()
H2OGPTEAsync.ingest_website()
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_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_jobs()
H2OGPTEAsync.list_list_chat_message_meta()
H2OGPTEAsync.list_prompt_permissions()
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.process_document()
H2OGPTEAsync.reset_collection_prompt_settings()
H2OGPTEAsync.run_selftest()
H2OGPTEAsync.search_chunks()
H2OGPTEAsync.set_chat_message_votes()
H2OGPTEAsync.set_chat_session_collection()
H2OGPTEAsync.set_chat_session_prompt_template()
H2OGPTEAsync.set_collection_prompt_template()
H2OGPTEAsync.share_collection()
H2OGPTEAsync.share_prompt()
H2OGPTEAsync.summarize_content()
H2OGPTEAsync.summarize_document()
H2OGPTEAsync.tag_document()
H2OGPTEAsync.unshare_collection()
H2OGPTEAsync.unshare_collection_for_all()
H2OGPTEAsync.unshare_prompt()
H2OGPTEAsync.unshare_prompt_for_all()
H2OGPTEAsync.untag_document()
H2OGPTEAsync.update_collection()
H2OGPTEAsync.update_collection_rag_type()
H2OGPTEAsync.update_prompt_template()
H2OGPTEAsync.update_question_reply_feedback()
H2OGPTEAsync.update_tag()
H2OGPTEAsync.upload()
Session
SessionAsync
- Submodules
- Indices and Tables
- h2ogpte package