h2oGPTE Python API
h2oGPTe Python client API reference.
Note: The llm_args
field should not be used as it may result in unexpected behavior or errors. It will be supported in version 1.4.0 and later.
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_question_reply_feedback()
H2OGPTE.create_chat_session()
H2OGPTE.create_chat_session_on_default_collection()
H2OGPTE.create_collection()
H2OGPTE.delete_chat_sessions()
H2OGPTE.delete_collections()
H2OGPTE.delete_document_summaries()
H2OGPTE.delete_documents()
H2OGPTE.delete_documents_from_collection()
H2OGPTE.delete_upload()
H2OGPTE.download_document()
H2OGPTE.encode_for_retrieval()
H2OGPTE.extract_data()
H2OGPTE.get_chunks()
H2OGPTE.get_collection()
H2OGPTE.get_collection_for_chat_session()
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_scheduler_stats()
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_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_upload()
H2OGPTE.list_users()
H2OGPTE.make_collection_private()
H2OGPTE.make_collection_public()
H2OGPTE.match_chunks()
H2OGPTE.openid_connect()
H2OGPTE.reset_collection_prompt_settings()
H2OGPTE.search_chunks()
H2OGPTE.set_chat_message_votes()
H2OGPTE.share_collection()
H2OGPTE.summarize_content()
H2OGPTE.summarize_document()
H2OGPTE.unshare_collection()
H2OGPTE.unshare_collection_for_all()
H2OGPTE.update_collection()
H2OGPTE.update_collection_prompt_settings()
H2OGPTE.upload()
marshal()
unmarshal()
- h2ogpte.session module
- h2ogpte.types module
Answer
ChatAcknowledgement
ChatMessage
ChatMessageFull
ChatMessageMeta
ChatMessageReference
ChatRequest
ChatRequest.body
ChatRequest.correlation_id
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
ChatResponse
ChatSessionCount
ChatSessionForCollection
ChatSessionInfo
Chunk
Chunks
Collection
Collection.auto_gen_description_prompt
Collection.created_at
Collection.description
Collection.document_count
Collection.document_size
Collection.hyde_no_rag_llm_prompt_extension
Collection.id
Collection.is_public
Collection.model_config
Collection.model_fields
Collection.name
Collection.pre_prompt_query
Collection.prompt_query
Collection.rag_type
Collection.system_prompt
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
DocumentCount
DocumentInfo
DocumentInfoSummary
DocumentInfoSummary.id
DocumentInfoSummary.model_config
DocumentInfoSummary.model_fields
DocumentInfoSummary.name
DocumentInfoSummary.page_count
DocumentInfoSummary.size
DocumentInfoSummary.status
DocumentInfoSummary.summary
DocumentInfoSummary.summary_parameters
DocumentInfoSummary.type
DocumentInfoSummary.updated_at
DocumentSummary
ExtractionAnswer
Identifier
InvalidArgumentError
Job
JobKind
JobKind.DeleteCollectionsJob
JobKind.DeleteDocumentsFromCollectionJob
JobKind.DeleteDocumentsJob
JobKind.DocumentSummaryJob
JobKind.ImportDocumentIntoCollectionJob
JobKind.IndexFilesJob
JobKind.IngestFromFileSystemJob
JobKind.IngestUploadsJob
JobKind.IngestWebsiteJob
JobKind.NoOpJob
JobKind.UpdateCollectionStatsJob
JobStatus
LLMUsage
LLMUsageLimit
Meta
ObjectCount
ObjectNotFoundError
PartialChatMessage
Permission
QuestionReplyData
QuestionReplyData.collection_documents
QuestionReplyData.collection_id
QuestionReplyData.collection_name
QuestionReplyData.expected_answer
QuestionReplyData.llm
QuestionReplyData.model_config
QuestionReplyData.model_fields
QuestionReplyData.pre_prompt_query
QuestionReplyData.pre_prompt_summary
QuestionReplyData.prompt_query
QuestionReplyData.prompt_summary
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
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_question_reply_feedback()
H2OGPTE.create_chat_session()
H2OGPTE.create_chat_session_on_default_collection()
H2OGPTE.create_collection()
H2OGPTE.delete_chat_sessions()
H2OGPTE.delete_collections()
H2OGPTE.delete_document_summaries()
H2OGPTE.delete_documents()
H2OGPTE.delete_documents_from_collection()
H2OGPTE.delete_upload()
H2OGPTE.download_document()
H2OGPTE.encode_for_retrieval()
H2OGPTE.extract_data()
H2OGPTE.get_chunks()
H2OGPTE.get_collection()
H2OGPTE.get_collection_for_chat_session()
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_scheduler_stats()
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_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_upload()
H2OGPTE.list_users()
H2OGPTE.make_collection_private()
H2OGPTE.make_collection_public()
H2OGPTE.match_chunks()
H2OGPTE.openid_connect()
H2OGPTE.reset_collection_prompt_settings()
H2OGPTE.search_chunks()
H2OGPTE.set_chat_message_votes()
H2OGPTE.share_collection()
H2OGPTE.summarize_content()
H2OGPTE.summarize_document()
H2OGPTE.unshare_collection()
H2OGPTE.unshare_collection_for_all()
H2OGPTE.update_collection()
H2OGPTE.update_collection_prompt_settings()
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_question_reply_feedback()
H2OGPTEAsync.create_chat_session()
H2OGPTEAsync.create_chat_session_on_default_collection()
H2OGPTEAsync.create_collection()
H2OGPTEAsync.delete_chat_sessions()
H2OGPTEAsync.delete_collections()
H2OGPTEAsync.delete_document_summaries()
H2OGPTEAsync.delete_documents()
H2OGPTEAsync.delete_documents_from_collection()
H2OGPTEAsync.delete_upload()
H2OGPTEAsync.download_document()
H2OGPTEAsync.encode_for_retrieval()
H2OGPTEAsync.extract_data()
H2OGPTEAsync.get_chunks()
H2OGPTEAsync.get_collection()
H2OGPTEAsync.get_collection_for_chat_session()
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_scheduler_stats()
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_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_upload()
H2OGPTEAsync.list_users()
H2OGPTEAsync.make_collection_private()
H2OGPTEAsync.make_collection_public()
H2OGPTEAsync.match_chunks()
H2OGPTEAsync.openid_connect()
H2OGPTEAsync.reset_collection_prompt_settings()
H2OGPTEAsync.search_chunks()
H2OGPTEAsync.set_chat_message_votes()
H2OGPTEAsync.share_collection()
H2OGPTEAsync.summarize_content()
H2OGPTEAsync.summarize_document()
H2OGPTEAsync.unshare_collection()
H2OGPTEAsync.unshare_collection_for_all()
H2OGPTEAsync.update_collection()
H2OGPTEAsync.update_collection_prompt_settings()
H2OGPTEAsync.upload()
Session
SessionAsync
- Submodules