h2ogpte 1.6.41rc3__py3-none-any.whl → 1.6.41rc5__py3-none-any.whl

h2ogpte/rest_async/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.6.41-dev3/python'
+        self.user_agent = 'OpenAPI-Generator/1.6.41-dev5/python'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

h2ogpte/rest_async/configuration.py

@@ -499,7 +499,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v1.0.0\n"\
-               "SDK Package Version: 1.6.41-dev3".\
+               "SDK Package Version: 1.6.41-dev5".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

h2ogpte/rest_async/models/__init__.py

@@ -67,6 +67,8 @@ from h2ogpte.rest_async.models.embedding_model import EmbeddingModel
 from h2ogpte.rest_async.models.encode_chunks_for_retrieval_request import EncodeChunksForRetrievalRequest
 from h2ogpte.rest_async.models.endpoint_error import EndpointError
 from h2ogpte.rest_async.models.extraction_request import ExtractionRequest
+from h2ogpte.rest_async.models.extractor import Extractor
+from h2ogpte.rest_async.models.extractor_create_request import ExtractorCreateRequest
 from h2ogpte.rest_async.models.gcs_credentials import GCSCredentials
 from h2ogpte.rest_async.models.global_configuration_item import GlobalConfigurationItem
 from h2ogpte.rest_async.models.group_create_request import GroupCreateRequest

h2ogpte/rest_async/models/extractor.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    h2oGPTe REST API
+
+     # Overview   Users can easily interact with the h2oGPTe API through its REST API, allowing HTTP requests from any programming language.  ## Authorization: Getting an API key  Sign up/in at Enterprise h2oGPTe and generate one of the following two types of API keys:   - **Global API key**: If a Collection is not specified when creating a new API Key, that key is considered to be a global API Key. Use global API Keys to grant full user impersonation and system-wide access to all of your work. Anyone with access to one of your global API Keys can create, delete, or interact with any of your past, current, and future Collections, Documents, Chats, and settings.  - **Collection-specific API key**: Use Collection-specific API Keys to grant external access to only Chat with a specified Collection and make related API calls to it. Collection-specific API keys do not allow other API calls, such as creation, deletion, or access to other Collections or Chats.   Access Enterprise h2oGPTe through your [H2O Generative AI](https://genai.h2o.ai/appstore) app store account, available with a freemium tier.  ## Authorization: Using an API key   All h2oGPTe REST API requests must include an API Key in the \"Authorization\" HTTP header, formatted as follows:  ``` Authorization: Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ```  ```sh curl -X 'POST' \\   'https://h2ogpte.genai.h2o.ai/api/v1/collections' \\   -H 'accept: application/json' \\   -H 'Content-Type: application/json' \\   -H 'Authorization: Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \\   -d '{     \"name\": \"The name of my Collection\",     \"description\": \"The description of my Collection\",     \"embedding_model\": \"BAAI/bge-large-en-v1.5\"   }' ```      ## Interactive h2oGPTe API testing  This page only showcases the h2oGPTe REST API; you can test it directly in the [Swagger UI](https://h2ogpte.genai.h2o.ai/swagger-ui/). Ensure that you are logged into your Enterprise h2oGPTe account. 
+
+    The version of the OpenAPI document: v1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Extractor(BaseModel):
+    """
+    Extractor
+    """ # noqa: E501
+    name: StrictStr = Field(description="Human-readable name")
+    description: StrictStr = Field(description="What this extractor does")
+    llm: Optional[StrictStr] = Field(default=None, description="(Optional) Identifier or version of the language model the extractor uses")
+    var_schema: Optional[StrictStr] = Field(default=None, description="(Optional) JSONSchema (or other spec) that the extractor outputs", alias="schema")
+    id: StrictStr = Field(description="Unique identifier of the extractor")
+    created_at: datetime = Field(description="When the extractor definition was created")
+    __properties: ClassVar[List[str]] = ["name", "description", "llm", "schema", "id", "created_at"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Extractor from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Extractor from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "llm": obj.get("llm"),
+            "schema": obj.get("schema"),
+            "id": obj.get("id"),
+            "created_at": obj.get("created_at")
+        })
+        return _obj
+
+

h2ogpte/rest_async/models/extractor_create_request.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    h2oGPTe REST API
+
+     # Overview   Users can easily interact with the h2oGPTe API through its REST API, allowing HTTP requests from any programming language.  ## Authorization: Getting an API key  Sign up/in at Enterprise h2oGPTe and generate one of the following two types of API keys:   - **Global API key**: If a Collection is not specified when creating a new API Key, that key is considered to be a global API Key. Use global API Keys to grant full user impersonation and system-wide access to all of your work. Anyone with access to one of your global API Keys can create, delete, or interact with any of your past, current, and future Collections, Documents, Chats, and settings.  - **Collection-specific API key**: Use Collection-specific API Keys to grant external access to only Chat with a specified Collection and make related API calls to it. Collection-specific API keys do not allow other API calls, such as creation, deletion, or access to other Collections or Chats.   Access Enterprise h2oGPTe through your [H2O Generative AI](https://genai.h2o.ai/appstore) app store account, available with a freemium tier.  ## Authorization: Using an API key   All h2oGPTe REST API requests must include an API Key in the \"Authorization\" HTTP header, formatted as follows:  ``` Authorization: Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ```  ```sh curl -X 'POST' \\   'https://h2ogpte.genai.h2o.ai/api/v1/collections' \\   -H 'accept: application/json' \\   -H 'Content-Type: application/json' \\   -H 'Authorization: Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \\   -d '{     \"name\": \"The name of my Collection\",     \"description\": \"The description of my Collection\",     \"embedding_model\": \"BAAI/bge-large-en-v1.5\"   }' ```      ## Interactive h2oGPTe API testing  This page only showcases the h2oGPTe REST API; you can test it directly in the [Swagger UI](https://h2ogpte.genai.h2o.ai/swagger-ui/). Ensure that you are logged into your Enterprise h2oGPTe account. 
+
+    The version of the OpenAPI document: v1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExtractorCreateRequest(BaseModel):
+    """
+    ExtractorCreateRequest
+    """ # noqa: E501
+    name: StrictStr = Field(description="Human-readable name")
+    description: StrictStr = Field(description="What this extractor does")
+    llm: StrictStr = Field(description="Identifier or version of the language model the extractor uses")
+    var_schema: StrictStr = Field(description="JSONSchema (or other spec) that the extractor outputs", alias="schema")
+    __properties: ClassVar[List[str]] = ["name", "description", "llm", "schema"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ExtractorCreateRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExtractorCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "llm": obj.get("llm"),
+            "schema": obj.get("schema")
+        })
+        return _obj
+
+

h2ogpte/rest_sync/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.6.41-dev3"
+__version__ = "1.6.41-dev5"
 
 # import apis into sdk package
 from h2ogpte.rest_sync.api.api_keys_api import APIKeysApi
@@ -24,6 +24,7 @@ from h2ogpte.rest_sync.api.collections_api import CollectionsApi
 from h2ogpte.rest_sync.api.configurations_api import ConfigurationsApi
 from h2ogpte.rest_sync.api.document_ingestion_api import DocumentIngestionApi
 from h2ogpte.rest_sync.api.documents_api import DocumentsApi
+from h2ogpte.rest_sync.api.extractors_api import ExtractorsApi
 from h2ogpte.rest_sync.api.jobs_api import JobsApi
 from h2ogpte.rest_sync.api.models_api import ModelsApi
 from h2ogpte.rest_sync.api.permissions_api import PermissionsApi
@@ -97,6 +98,8 @@ from h2ogpte.rest_sync.models.embedding_model import EmbeddingModel
 from h2ogpte.rest_sync.models.encode_chunks_for_retrieval_request import EncodeChunksForRetrievalRequest
 from h2ogpte.rest_sync.models.endpoint_error import EndpointError
 from h2ogpte.rest_sync.models.extraction_request import ExtractionRequest
+from h2ogpte.rest_sync.models.extractor import Extractor
+from h2ogpte.rest_sync.models.extractor_create_request import ExtractorCreateRequest
 from h2ogpte.rest_sync.models.gcs_credentials import GCSCredentials
 from h2ogpte.rest_sync.models.global_configuration_item import GlobalConfigurationItem
 from h2ogpte.rest_sync.models.group_create_request import GroupCreateRequest

h2ogpte/rest_sync/api/__init__.py

@@ -8,6 +8,7 @@ from h2ogpte.rest_sync.api.collections_api import CollectionsApi
 from h2ogpte.rest_sync.api.configurations_api import ConfigurationsApi
 from h2ogpte.rest_sync.api.document_ingestion_api import DocumentIngestionApi
 from h2ogpte.rest_sync.api.documents_api import DocumentsApi
+from h2ogpte.rest_sync.api.extractors_api import ExtractorsApi
 from h2ogpte.rest_sync.api.jobs_api import JobsApi
 from h2ogpte.rest_sync.api.models_api import ModelsApi
 from h2ogpte.rest_sync.api.permissions_api import PermissionsApi