openapiopenai 1.0.0__py3-none-any.whl

openapiopenai/models/create_completion_request_stop.py

@@ -0,0 +1,151 @@
+# coding: utf-8
+
+"""
+    OpenAI API
+
+    APIs for sampling from and fine-tuning language models
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: blah+oapicf@cliffano.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from typing_extensions import Annotated
+from pydantic import StrictStr, Field
+from typing import Union, List, Optional, Dict
+from typing_extensions import Literal, Self
+
+CREATECOMPLETIONREQUESTSTOP_ONE_OF_SCHEMAS = ["List[str]", "str"]
+
+class CreateCompletionRequestStop(BaseModel):
+    """
+    Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. 
+    """
+    # data type: str
+    oneof_schema_1_validator: Optional[StrictStr] = '<|endoftext|>'
+    # data type: List[str]
+    oneof_schema_2_validator: Optional[Annotated[List[StrictStr], Field(min_length=1, max_length=4)]] = None
+    actual_instance: Optional[Union[List[str], str]] = None
+    one_of_schemas: List[str] = Field(default=Literal["List[str]", "str"])
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        if v is None:
+            return v
+
+        instance = CreateCompletionRequestStop.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: str
+        try:
+            instance.oneof_schema_1_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: List[str]
+        try:
+            instance.oneof_schema_2_validator = v
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in CreateCompletionRequestStop with oneOf schemas: List[str], str. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in CreateCompletionRequestStop with oneOf schemas: List[str], str. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: Optional[str]) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        if json_str is None:
+            return instance
+
+        error_messages = []
+        match = 0
+
+        # deserialize data into str
+        try:
+            # validation
+            instance.oneof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.oneof_schema_1_validator
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into List[str]
+        try:
+            # validation
+            instance.oneof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.oneof_schema_2_validator
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into CreateCompletionRequestStop with oneOf schemas: List[str], str. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into CreateCompletionRequestStop with oneOf schemas: List[str], str. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], List[str], str]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

openapiopenai/models/create_completion_response.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    OpenAI API
+
+    APIs for sampling from and fine-tuning language models
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: blah+oapicf@cliffano.com
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from openapiopenai.models.create_completion_response_choices_inner import CreateCompletionResponseChoicesInner
+from openapiopenai.models.create_completion_response_usage import CreateCompletionResponseUsage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateCompletionResponse(BaseModel):
+    """
+    CreateCompletionResponse
+    """ # noqa: E501
+    id: StrictStr
+    object: StrictStr
+    created: StrictInt
+    model: StrictStr
+    choices: List[CreateCompletionResponseChoicesInner]
+    usage: Optional[CreateCompletionResponseUsage] = None
+    __properties: ClassVar[List[str]] = ["id", "object", "created", "model", "choices", "usage"]
+
+    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 CreateCompletionResponse 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in choices (list)
+        _items = []
+        if self.choices:
+            for _item in self.choices:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['choices'] = _items
+        # override the default output from pydantic by calling `to_dict()` of usage
+        if self.usage:
+            _dict['usage'] = self.usage.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateCompletionResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "object": obj.get("object"),
+            "created": obj.get("created"),
+            "model": obj.get("model"),
+            "choices": [CreateCompletionResponseChoicesInner.from_dict(_item) for _item in obj["choices"]] if obj.get("choices") is not None else None,
+            "usage": CreateCompletionResponseUsage.from_dict(obj["usage"]) if obj.get("usage") is not None else None
+        })
+        return _obj
+
+

openapiopenai/models/create_completion_response_choices_inner.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    OpenAI API
+
+    APIs for sampling from and fine-tuning language models
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: blah+oapicf@cliffano.com
+    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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from openapiopenai.models.create_completion_response_choices_inner_logprobs import CreateCompletionResponseChoicesInnerLogprobs
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateCompletionResponseChoicesInner(BaseModel):
+    """
+    CreateCompletionResponseChoicesInner
+    """ # noqa: E501
+    text: StrictStr
+    index: StrictInt
+    logprobs: Optional[CreateCompletionResponseChoicesInnerLogprobs]
+    finish_reason: StrictStr
+    __properties: ClassVar[List[str]] = ["text", "index", "logprobs", "finish_reason"]
+
+    @field_validator('finish_reason')
+    def finish_reason_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['stop', 'length']):
+            raise ValueError("must be one of enum values ('stop', 'length')")
+        return value
+
+    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 CreateCompletionResponseChoicesInner 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of logprobs
+        if self.logprobs:
+            _dict['logprobs'] = self.logprobs.to_dict()
+        # set to None if logprobs (nullable) is None
+        # and model_fields_set contains the field
+        if self.logprobs is None and "logprobs" in self.model_fields_set:
+            _dict['logprobs'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateCompletionResponseChoicesInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "index": obj.get("index"),
+            "logprobs": CreateCompletionResponseChoicesInnerLogprobs.from_dict(obj["logprobs"]) if obj.get("logprobs") is not None else None,
+            "finish_reason": obj.get("finish_reason")
+        })
+        return _obj
+
+

openapiopenai/models/create_completion_response_choices_inner_logprobs.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    OpenAI API
+
+    APIs for sampling from and fine-tuning language models
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: blah+oapicf@cliffano.com
+    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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateCompletionResponseChoicesInnerLogprobs(BaseModel):
+    """
+    CreateCompletionResponseChoicesInnerLogprobs
+    """ # noqa: E501
+    tokens: Optional[List[StrictStr]] = None
+    token_logprobs: Optional[List[Union[StrictFloat, StrictInt]]] = None
+    top_logprobs: Optional[List[Dict[str, Any]]] = None
+    text_offset: Optional[List[StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["tokens", "token_logprobs", "top_logprobs", "text_offset"]
+
+    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 CreateCompletionResponseChoicesInnerLogprobs 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 CreateCompletionResponseChoicesInnerLogprobs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tokens": obj.get("tokens"),
+            "token_logprobs": obj.get("token_logprobs"),
+            "top_logprobs": obj.get("top_logprobs"),
+            "text_offset": obj.get("text_offset")
+        })
+        return _obj
+
+

openapiopenai/models/create_completion_response_usage.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    OpenAI API
+
+    APIs for sampling from and fine-tuning language models
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: blah+oapicf@cliffano.com
+    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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateCompletionResponseUsage(BaseModel):
+    """
+    CreateCompletionResponseUsage
+    """ # noqa: E501
+    prompt_tokens: StrictInt
+    completion_tokens: StrictInt
+    total_tokens: StrictInt
+    __properties: ClassVar[List[str]] = ["prompt_tokens", "completion_tokens", "total_tokens"]
+
+    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 CreateCompletionResponseUsage 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 CreateCompletionResponseUsage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt_tokens": obj.get("prompt_tokens"),
+            "completion_tokens": obj.get("completion_tokens"),
+            "total_tokens": obj.get("total_tokens")
+        })
+        return _obj
+
+

openapiopenai/models/create_edit_request.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+    OpenAI API
+
+    APIs for sampling from and fine-tuning language models
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: blah+oapicf@cliffano.com
+    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, Optional, Union
+from typing_extensions import Annotated
+from openapiopenai.models.create_edit_request_model import CreateEditRequestModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateEditRequest(BaseModel):
+    """
+    CreateEditRequest
+    """ # noqa: E501
+    model: CreateEditRequestModel
+    input: Optional[StrictStr] = Field(default='', description="The input text to use as a starting point for the edit.")
+    instruction: StrictStr = Field(description="The instruction that tells the model how to edit the prompt.")
+    n: Optional[Annotated[int, Field(le=20, strict=True, ge=1)]] = Field(default=1, description="How many edits to generate for the input and instruction.")
+    temperature: Optional[Union[Annotated[float, Field(le=2, strict=True, ge=0)], Annotated[int, Field(le=2, strict=True, ge=0)]]] = Field(default=1, description="What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.  We generally recommend altering this or `top_p` but not both. ")
+    top_p: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=1, description="An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.  We generally recommend altering this or `temperature` but not both. ")
+    __properties: ClassVar[List[str]] = ["model", "input", "instruction", "n", "temperature", "top_p"]
+
+    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 CreateEditRequest 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of model
+        if self.model:
+            _dict['model'] = self.model.to_dict()
+        # set to None if input (nullable) is None
+        # and model_fields_set contains the field
+        if self.input is None and "input" in self.model_fields_set:
+            _dict['input'] = None
+
+        # set to None if n (nullable) is None
+        # and model_fields_set contains the field
+        if self.n is None and "n" in self.model_fields_set:
+            _dict['n'] = None
+
+        # set to None if temperature (nullable) is None
+        # and model_fields_set contains the field
+        if self.temperature is None and "temperature" in self.model_fields_set:
+            _dict['temperature'] = None
+
+        # set to None if top_p (nullable) is None
+        # and model_fields_set contains the field
+        if self.top_p is None and "top_p" in self.model_fields_set:
+            _dict['top_p'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateEditRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "model": CreateEditRequestModel.from_dict(obj["model"]) if obj.get("model") is not None else None,
+            "input": obj.get("input") if obj.get("input") is not None else '',
+            "instruction": obj.get("instruction"),
+            "n": obj.get("n") if obj.get("n") is not None else 1,
+            "temperature": obj.get("temperature") if obj.get("temperature") is not None else 1,
+            "top_p": obj.get("top_p") if obj.get("top_p") is not None else 1
+        })
+        return _obj
+
+