h2ogpte 1.6.38rc3__py3-none-any.whl → 1.6.40__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. h2ogpte/__init__.py +1 -1
  2. h2ogpte/errors.py +0 -4
  3. h2ogpte/h2ogpte.py +71 -369
  4. h2ogpte/h2ogpte_async.py +75 -374
  5. h2ogpte/h2ogpte_sync_base.py +0 -5
  6. h2ogpte/rest_async/__init__.py +3 -8
  7. h2ogpte/rest_async/api/__init__.py +0 -1
  8. h2ogpte/rest_async/api/configurations_api.py +137 -1006
  9. h2ogpte/rest_async/api/permissions_api.py +429 -177
  10. h2ogpte/rest_async/api/prompt_templates_api.py +303 -1240
  11. h2ogpte/rest_async/api_client.py +1 -1
  12. h2ogpte/rest_async/configuration.py +1 -1
  13. h2ogpte/rest_async/models/__init__.py +2 -6
  14. h2ogpte/rest_async/models/{create_secret201_response.py → confirm_user_deletion_request.py} +8 -8
  15. h2ogpte/rest_async/models/prompt_template.py +2 -8
  16. h2ogpte/rest_async/models/role_info.py +3 -5
  17. h2ogpte/rest_async/models/{update_secret_request.py → user_deletion_request.py} +8 -8
  18. h2ogpte/rest_sync/__init__.py +3 -8
  19. h2ogpte/rest_sync/api/__init__.py +0 -1
  20. h2ogpte/rest_sync/api/configurations_api.py +137 -1006
  21. h2ogpte/rest_sync/api/permissions_api.py +429 -177
  22. h2ogpte/rest_sync/api/prompt_templates_api.py +303 -1240
  23. h2ogpte/rest_sync/api_client.py +1 -1
  24. h2ogpte/rest_sync/configuration.py +1 -1
  25. h2ogpte/rest_sync/models/__init__.py +2 -6
  26. h2ogpte/rest_sync/models/{create_secret201_response.py → confirm_user_deletion_request.py} +8 -8
  27. h2ogpte/rest_sync/models/prompt_template.py +2 -8
  28. h2ogpte/rest_sync/models/role_info.py +3 -5
  29. h2ogpte/rest_sync/models/{update_secret_request.py → user_deletion_request.py} +8 -8
  30. h2ogpte/types.py +4 -10
  31. {h2ogpte-1.6.38rc3.dist-info → h2ogpte-1.6.40.dist-info}/METADATA +1 -1
  32. {h2ogpte-1.6.38rc3.dist-info → h2ogpte-1.6.40.dist-info}/RECORD +34 -44
  33. h2ogpte/rest_async/api/secrets_api.py +0 -1698
  34. h2ogpte/rest_async/models/create_secret_request.py +0 -101
  35. h2ogpte/rest_async/models/set_role_priority_request.py +0 -87
  36. h2ogpte/rest_async/models/update_default_prompt_template_visibility_request.py +0 -87
  37. h2ogpte/rest_async/models/update_prompt_template_privacy_request.py +0 -87
  38. h2ogpte/rest_sync/api/secrets_api.py +0 -1698
  39. h2ogpte/rest_sync/models/create_secret_request.py +0 -101
  40. h2ogpte/rest_sync/models/set_role_priority_request.py +0 -87
  41. h2ogpte/rest_sync/models/update_default_prompt_template_visibility_request.py +0 -87
  42. h2ogpte/rest_sync/models/update_prompt_template_privacy_request.py +0 -87
  43. {h2ogpte-1.6.38rc3.dist-info → h2ogpte-1.6.40.dist-info}/WHEEL +0 -0
  44. {h2ogpte-1.6.38rc3.dist-info → h2ogpte-1.6.40.dist-info}/top_level.txt +0 -0
@@ -1,101 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- h2oGPTe REST API
5
-
6
- # 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.
7
-
8
- The version of the OpenAPI document: v1.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
-
15
- from __future__ import annotations
16
- import pprint
17
- import re # noqa: F401
18
- import json
19
-
20
- from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
21
- from typing import Any, ClassVar, Dict, List, Optional
22
- from typing import Optional, Set
23
- from typing_extensions import Self
24
-
25
- class CreateSecretRequest(BaseModel):
26
- """
27
- CreateSecretRequest
28
- """ # noqa: E501
29
- secret_id: StrictStr = Field(description="The ID (name) of the secret")
30
- secret_value: Dict[str, Any] = Field(description="The secret data")
31
- secret_type: Optional[StrictStr] = Field(default=None, description="The type of the secret (e.g., s3, gcs, azure_blob)")
32
- __properties: ClassVar[List[str]] = ["secret_id", "secret_value", "secret_type"]
33
-
34
- @field_validator('secret_type')
35
- def secret_type_validate_enum(cls, value):
36
- """Validates the enum"""
37
- if value is None:
38
- return value
39
-
40
- if value not in set(['s3', 'gcs', 'azure_key', 'azure_sas']):
41
- raise ValueError("must be one of enum values ('s3', 'gcs', 'azure_key', 'azure_sas')")
42
- return value
43
-
44
- model_config = ConfigDict(
45
- populate_by_name=True,
46
- validate_assignment=True,
47
- protected_namespaces=(),
48
- )
49
-
50
-
51
- def to_str(self) -> str:
52
- """Returns the string representation of the model using alias"""
53
- return pprint.pformat(self.model_dump(by_alias=True))
54
-
55
- def to_json(self) -> str:
56
- """Returns the JSON representation of the model using alias"""
57
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
58
- return json.dumps(self.to_dict())
59
-
60
- @classmethod
61
- def from_json(cls, json_str: str) -> Optional[Self]:
62
- """Create an instance of CreateSecretRequest from a JSON string"""
63
- return cls.from_dict(json.loads(json_str))
64
-
65
- def to_dict(self) -> Dict[str, Any]:
66
- """Return the dictionary representation of the model using alias.
67
-
68
- This has the following differences from calling pydantic's
69
- `self.model_dump(by_alias=True)`:
70
-
71
- * `None` is only added to the output dict for nullable fields that
72
- were set at model initialization. Other fields with value `None`
73
- are ignored.
74
- """
75
- excluded_fields: Set[str] = set([
76
- ])
77
-
78
- _dict = self.model_dump(
79
- by_alias=True,
80
- exclude=excluded_fields,
81
- exclude_none=True,
82
- )
83
- return _dict
84
-
85
- @classmethod
86
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
87
- """Create an instance of CreateSecretRequest from a dict"""
88
- if obj is None:
89
- return None
90
-
91
- if not isinstance(obj, dict):
92
- return cls.model_validate(obj)
93
-
94
- _obj = cls.model_validate({
95
- "secret_id": obj.get("secret_id"),
96
- "secret_value": obj.get("secret_value"),
97
- "secret_type": obj.get("secret_type")
98
- })
99
- return _obj
100
-
101
-
@@ -1,87 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- h2oGPTe REST API
5
-
6
- # 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.
7
-
8
- The version of the OpenAPI document: v1.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
-
15
- from __future__ import annotations
16
- import pprint
17
- import re # noqa: F401
18
- import json
19
-
20
- from pydantic import BaseModel, ConfigDict, Field, StrictInt
21
- from typing import Any, ClassVar, Dict, List
22
- from typing import Optional, Set
23
- from typing_extensions import Self
24
-
25
- class SetRolePriorityRequest(BaseModel):
26
- """
27
- SetRolePriorityRequest
28
- """ # noqa: E501
29
- priority: StrictInt = Field(description="The priority to be set for the role.")
30
- __properties: ClassVar[List[str]] = ["priority"]
31
-
32
- model_config = ConfigDict(
33
- populate_by_name=True,
34
- validate_assignment=True,
35
- protected_namespaces=(),
36
- )
37
-
38
-
39
- def to_str(self) -> str:
40
- """Returns the string representation of the model using alias"""
41
- return pprint.pformat(self.model_dump(by_alias=True))
42
-
43
- def to_json(self) -> str:
44
- """Returns the JSON representation of the model using alias"""
45
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
46
- return json.dumps(self.to_dict())
47
-
48
- @classmethod
49
- def from_json(cls, json_str: str) -> Optional[Self]:
50
- """Create an instance of SetRolePriorityRequest from a JSON string"""
51
- return cls.from_dict(json.loads(json_str))
52
-
53
- def to_dict(self) -> Dict[str, Any]:
54
- """Return the dictionary representation of the model using alias.
55
-
56
- This has the following differences from calling pydantic's
57
- `self.model_dump(by_alias=True)`:
58
-
59
- * `None` is only added to the output dict for nullable fields that
60
- were set at model initialization. Other fields with value `None`
61
- are ignored.
62
- """
63
- excluded_fields: Set[str] = set([
64
- ])
65
-
66
- _dict = self.model_dump(
67
- by_alias=True,
68
- exclude=excluded_fields,
69
- exclude_none=True,
70
- )
71
- return _dict
72
-
73
- @classmethod
74
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
75
- """Create an instance of SetRolePriorityRequest from a dict"""
76
- if obj is None:
77
- return None
78
-
79
- if not isinstance(obj, dict):
80
- return cls.model_validate(obj)
81
-
82
- _obj = cls.model_validate({
83
- "priority": obj.get("priority")
84
- })
85
- return _obj
86
-
87
-
@@ -1,87 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- h2oGPTe REST API
5
-
6
- # 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.
7
-
8
- The version of the OpenAPI document: v1.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
-
15
- from __future__ import annotations
16
- import pprint
17
- import re # noqa: F401
18
- import json
19
-
20
- from pydantic import BaseModel, ConfigDict, Field, StrictBool
21
- from typing import Any, ClassVar, Dict, List
22
- from typing import Optional, Set
23
- from typing_extensions import Self
24
-
25
- class UpdateDefaultPromptTemplateVisibilityRequest(BaseModel):
26
- """
27
- UpdateDefaultPromptTemplateVisibilityRequest
28
- """ # noqa: E501
29
- is_visible: StrictBool = Field(description="A flag specifying whether the default prompt template should be visible or not.")
30
- __properties: ClassVar[List[str]] = ["is_visible"]
31
-
32
- model_config = ConfigDict(
33
- populate_by_name=True,
34
- validate_assignment=True,
35
- protected_namespaces=(),
36
- )
37
-
38
-
39
- def to_str(self) -> str:
40
- """Returns the string representation of the model using alias"""
41
- return pprint.pformat(self.model_dump(by_alias=True))
42
-
43
- def to_json(self) -> str:
44
- """Returns the JSON representation of the model using alias"""
45
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
46
- return json.dumps(self.to_dict())
47
-
48
- @classmethod
49
- def from_json(cls, json_str: str) -> Optional[Self]:
50
- """Create an instance of UpdateDefaultPromptTemplateVisibilityRequest from a JSON string"""
51
- return cls.from_dict(json.loads(json_str))
52
-
53
- def to_dict(self) -> Dict[str, Any]:
54
- """Return the dictionary representation of the model using alias.
55
-
56
- This has the following differences from calling pydantic's
57
- `self.model_dump(by_alias=True)`:
58
-
59
- * `None` is only added to the output dict for nullable fields that
60
- were set at model initialization. Other fields with value `None`
61
- are ignored.
62
- """
63
- excluded_fields: Set[str] = set([
64
- ])
65
-
66
- _dict = self.model_dump(
67
- by_alias=True,
68
- exclude=excluded_fields,
69
- exclude_none=True,
70
- )
71
- return _dict
72
-
73
- @classmethod
74
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
75
- """Create an instance of UpdateDefaultPromptTemplateVisibilityRequest from a dict"""
76
- if obj is None:
77
- return None
78
-
79
- if not isinstance(obj, dict):
80
- return cls.model_validate(obj)
81
-
82
- _obj = cls.model_validate({
83
- "is_visible": obj.get("is_visible")
84
- })
85
- return _obj
86
-
87
-
@@ -1,87 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- h2oGPTe REST API
5
-
6
- # 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.
7
-
8
- The version of the OpenAPI document: v1.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
-
15
- from __future__ import annotations
16
- import pprint
17
- import re # noqa: F401
18
- import json
19
-
20
- from pydantic import BaseModel, ConfigDict, Field, StrictBool
21
- from typing import Any, ClassVar, Dict, List
22
- from typing import Optional, Set
23
- from typing_extensions import Self
24
-
25
- class UpdatePromptTemplatePrivacyRequest(BaseModel):
26
- """
27
- UpdatePromptTemplatePrivacyRequest
28
- """ # noqa: E501
29
- is_public: StrictBool = Field(description="A flag specifying whether a prompt template is private or public.")
30
- __properties: ClassVar[List[str]] = ["is_public"]
31
-
32
- model_config = ConfigDict(
33
- populate_by_name=True,
34
- validate_assignment=True,
35
- protected_namespaces=(),
36
- )
37
-
38
-
39
- def to_str(self) -> str:
40
- """Returns the string representation of the model using alias"""
41
- return pprint.pformat(self.model_dump(by_alias=True))
42
-
43
- def to_json(self) -> str:
44
- """Returns the JSON representation of the model using alias"""
45
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
46
- return json.dumps(self.to_dict())
47
-
48
- @classmethod
49
- def from_json(cls, json_str: str) -> Optional[Self]:
50
- """Create an instance of UpdatePromptTemplatePrivacyRequest from a JSON string"""
51
- return cls.from_dict(json.loads(json_str))
52
-
53
- def to_dict(self) -> Dict[str, Any]:
54
- """Return the dictionary representation of the model using alias.
55
-
56
- This has the following differences from calling pydantic's
57
- `self.model_dump(by_alias=True)`:
58
-
59
- * `None` is only added to the output dict for nullable fields that
60
- were set at model initialization. Other fields with value `None`
61
- are ignored.
62
- """
63
- excluded_fields: Set[str] = set([
64
- ])
65
-
66
- _dict = self.model_dump(
67
- by_alias=True,
68
- exclude=excluded_fields,
69
- exclude_none=True,
70
- )
71
- return _dict
72
-
73
- @classmethod
74
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
75
- """Create an instance of UpdatePromptTemplatePrivacyRequest from a dict"""
76
- if obj is None:
77
- return None
78
-
79
- if not isinstance(obj, dict):
80
- return cls.model_validate(obj)
81
-
82
- _obj = cls.model_validate({
83
- "is_public": obj.get("is_public")
84
- })
85
- return _obj
86
-
87
-