yandexcloud 0.288.0__py3-none-any.whl → 0.289.0__py3-none-any.whl

yandex/cloud/ai/foundation_models/v1/text_common_pb2.pyi

@@ -0,0 +1,195 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import google.protobuf.wrappers_pb2
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class CompletionOptions(google.protobuf.message.Message):
+    """Defines the options for completion generation."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    STREAM_FIELD_NUMBER: builtins.int
+    TEMPERATURE_FIELD_NUMBER: builtins.int
+    MAX_TOKENS_FIELD_NUMBER: builtins.int
+    stream: builtins.bool
+    """Enables streaming of partially generated text."""
+    @property
+    def temperature(self) -> google.protobuf.wrappers_pb2.DoubleValue:
+        """Affects creativity and randomness of responses. Should be a double number between 0 (inclusive) and 1 (inclusive).
+        Lower values produce more straightforward responses while higher values lead to increased creativity and randomness.
+        Default temperature: 0.3
+        """
+
+    @property
+    def max_tokens(self) -> google.protobuf.wrappers_pb2.Int64Value:
+        """The limit on the number of tokens used for single completion generation.
+        Must be greater than zero. This maximum allowed parameter value may depend on the model being used.
+        """
+
+    def __init__(
+        self,
+        *,
+        stream: builtins.bool = ...,
+        temperature: google.protobuf.wrappers_pb2.DoubleValue | None = ...,
+        max_tokens: google.protobuf.wrappers_pb2.Int64Value | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["max_tokens", b"max_tokens", "temperature", b"temperature"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["max_tokens", b"max_tokens", "stream", b"stream", "temperature", b"temperature"]) -> None: ...
+
+global___CompletionOptions = CompletionOptions
+
+@typing.final
+class Message(google.protobuf.message.Message):
+    """A message object representing a wrapper over the inputs and outputs of the completion model."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROLE_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+    role: builtins.str
+    """The ID of the message sender. Supported roles:
+    * `system`: Special role used to define the behaviour of the completion model.
+    * `assistant`: A role used by the model to generate responses.
+    * `user`: A role used by the user to describe requests to the model.
+    """
+    text: builtins.str
+    """Textual content of the message."""
+    def __init__(
+        self,
+        *,
+        role: builtins.str = ...,
+        text: builtins.str = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["Content", b"Content", "text", b"text"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["Content", b"Content", "role", b"role", "text", b"text"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["Content", b"Content"]) -> typing.Literal["text"] | None: ...
+
+global___Message = Message
+
+@typing.final
+class ContentUsage(google.protobuf.message.Message):
+    """An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    INPUT_TEXT_TOKENS_FIELD_NUMBER: builtins.int
+    COMPLETION_TOKENS_FIELD_NUMBER: builtins.int
+    TOTAL_TOKENS_FIELD_NUMBER: builtins.int
+    input_text_tokens: builtins.int
+    """The number of tokens in the textual part of the model input."""
+    completion_tokens: builtins.int
+    """The total number of tokens in the generated completions."""
+    total_tokens: builtins.int
+    """The total number of tokens, including all input tokens and all generated tokens."""
+    def __init__(
+        self,
+        *,
+        input_text_tokens: builtins.int = ...,
+        completion_tokens: builtins.int = ...,
+        total_tokens: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["completion_tokens", b"completion_tokens", "input_text_tokens", b"input_text_tokens", "total_tokens", b"total_tokens"]) -> None: ...
+
+global___ContentUsage = ContentUsage
+
+@typing.final
+class Alternative(google.protobuf.message.Message):
+    """Represents a generated completion alternative, including its content and generation status."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _AlternativeStatus:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _AlternativeStatusEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[Alternative._AlternativeStatus.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        ALTERNATIVE_STATUS_UNSPECIFIED: Alternative._AlternativeStatus.ValueType  # 0
+        """Unspecified generation status."""
+        ALTERNATIVE_STATUS_PARTIAL: Alternative._AlternativeStatus.ValueType  # 1
+        """Partially generated alternative."""
+        ALTERNATIVE_STATUS_TRUNCATED_FINAL: Alternative._AlternativeStatus.ValueType  # 2
+        """Incomplete final alternative resulting from reaching the maximum allowed number of tokens."""
+        ALTERNATIVE_STATUS_FINAL: Alternative._AlternativeStatus.ValueType  # 3
+        """Final alternative generated without running into any limits."""
+        ALTERNATIVE_STATUS_CONTENT_FILTER: Alternative._AlternativeStatus.ValueType  # 4
+        """Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response.
+        To fix, modify the prompt and restart generation.
+        """
+
+    class AlternativeStatus(_AlternativeStatus, metaclass=_AlternativeStatusEnumTypeWrapper):
+        """Enum representing the generation status of the alternative."""
+
+    ALTERNATIVE_STATUS_UNSPECIFIED: Alternative.AlternativeStatus.ValueType  # 0
+    """Unspecified generation status."""
+    ALTERNATIVE_STATUS_PARTIAL: Alternative.AlternativeStatus.ValueType  # 1
+    """Partially generated alternative."""
+    ALTERNATIVE_STATUS_TRUNCATED_FINAL: Alternative.AlternativeStatus.ValueType  # 2
+    """Incomplete final alternative resulting from reaching the maximum allowed number of tokens."""
+    ALTERNATIVE_STATUS_FINAL: Alternative.AlternativeStatus.ValueType  # 3
+    """Final alternative generated without running into any limits."""
+    ALTERNATIVE_STATUS_CONTENT_FILTER: Alternative.AlternativeStatus.ValueType  # 4
+    """Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response.
+    To fix, modify the prompt and restart generation.
+    """
+
+    MESSAGE_FIELD_NUMBER: builtins.int
+    STATUS_FIELD_NUMBER: builtins.int
+    status: global___Alternative.AlternativeStatus.ValueType
+    """The generation status of the alternative"""
+    @property
+    def message(self) -> global___Message:
+        """A message containing the content of the alternative."""
+
+    def __init__(
+        self,
+        *,
+        message: global___Message | None = ...,
+        status: global___Alternative.AlternativeStatus.ValueType = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["message", b"message"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["message", b"message", "status", b"status"]) -> None: ...
+
+global___Alternative = Alternative
+
+@typing.final
+class Token(google.protobuf.message.Message):
+    """Represents a token, the basic unit of content, used by the foundation model."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+    SPECIAL_FIELD_NUMBER: builtins.int
+    id: builtins.int
+    """An internal token identifier."""
+    text: builtins.str
+    """The textual representation of the token."""
+    special: builtins.bool
+    """Indicates whether the token is special or not. Special tokens may define the model's behavior and are not visible to users."""
+    def __init__(
+        self,
+        *,
+        id: builtins.int = ...,
+        text: builtins.str = ...,
+        special: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["id", b"id", "special", b"special", "text", b"text"]) -> None: ...
+
+global___Token = Token

yandex/cloud/ai/foundation_models/v1/text_generation/text_generation_service_pb2.pyi

@@ -0,0 +1,122 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import typing
+import yandex.cloud.ai.foundation_models.v1.text_common_pb2
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class CompletionRequest(google.protobuf.message.Message):
+    """Request for the service to generate text completion."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MODEL_URI_FIELD_NUMBER: builtins.int
+    COMPLETION_OPTIONS_FIELD_NUMBER: builtins.int
+    MESSAGES_FIELD_NUMBER: builtins.int
+    model_uri: builtins.str
+    """The [ID of the model](/docs/foundation-models/concepts/yandexgpt/models) to be used for completion generation."""
+    @property
+    def completion_options(self) -> yandex.cloud.ai.foundation_models.v1.text_common_pb2.CompletionOptions:
+        """Configuration options for completion generation."""
+
+    @property
+    def messages(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.foundation_models.v1.text_common_pb2.Message]:
+        """A list of messages representing the context for the completion model."""
+
+    def __init__(
+        self,
+        *,
+        model_uri: builtins.str = ...,
+        completion_options: yandex.cloud.ai.foundation_models.v1.text_common_pb2.CompletionOptions | None = ...,
+        messages: collections.abc.Iterable[yandex.cloud.ai.foundation_models.v1.text_common_pb2.Message] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["completion_options", b"completion_options"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["completion_options", b"completion_options", "messages", b"messages", "model_uri", b"model_uri"]) -> None: ...
+
+global___CompletionRequest = CompletionRequest
+
+@typing.final
+class CompletionResponse(google.protobuf.message.Message):
+    """Response containing generated text completions."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ALTERNATIVES_FIELD_NUMBER: builtins.int
+    USAGE_FIELD_NUMBER: builtins.int
+    MODEL_VERSION_FIELD_NUMBER: builtins.int
+    model_version: builtins.str
+    """The model version changes with each new releases."""
+    @property
+    def alternatives(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.foundation_models.v1.text_common_pb2.Alternative]:
+        """A list of generated completion alternatives."""
+
+    @property
+    def usage(self) -> yandex.cloud.ai.foundation_models.v1.text_common_pb2.ContentUsage:
+        """A set of statistics describing the number of content tokens used by the completion model."""
+
+    def __init__(
+        self,
+        *,
+        alternatives: collections.abc.Iterable[yandex.cloud.ai.foundation_models.v1.text_common_pb2.Alternative] | None = ...,
+        usage: yandex.cloud.ai.foundation_models.v1.text_common_pb2.ContentUsage | None = ...,
+        model_version: builtins.str = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["usage", b"usage"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["alternatives", b"alternatives", "model_version", b"model_version", "usage", b"usage"]) -> None: ...
+
+global___CompletionResponse = CompletionResponse
+
+@typing.final
+class TokenizeRequest(google.protobuf.message.Message):
+    """Request for the service to tokenize input text."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MODEL_URI_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+    model_uri: builtins.str
+    """The identifier of the model to be used for tokenization."""
+    text: builtins.str
+    """Text to be tokenized."""
+    def __init__(
+        self,
+        *,
+        model_uri: builtins.str = ...,
+        text: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["model_uri", b"model_uri", "text", b"text"]) -> None: ...
+
+global___TokenizeRequest = TokenizeRequest
+
+@typing.final
+class TokenizeResponse(google.protobuf.message.Message):
+    """Response containing tokenized content from request."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    TOKENS_FIELD_NUMBER: builtins.int
+    MODEL_VERSION_FIELD_NUMBER: builtins.int
+    model_version: builtins.str
+    """Model version (changes with model releases)."""
+    @property
+    def tokens(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[yandex.cloud.ai.foundation_models.v1.text_common_pb2.Token]:
+        """A list of tokens obtained from tokenization."""
+
+    def __init__(
+        self,
+        *,
+        tokens: collections.abc.Iterable[yandex.cloud.ai.foundation_models.v1.text_common_pb2.Token] | None = ...,
+        model_version: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["model_version", b"model_version", "tokens", b"tokens"]) -> None: ...
+
+global___TokenizeResponse = TokenizeResponse

yandex/cloud/ai/llm/v1alpha/llm_pb2.pyi

@@ -0,0 +1,121 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import google.protobuf.wrappers_pb2
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class GenerationOptions(google.protobuf.message.Message):
+    """Defines the options for text generation."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PARTIAL_RESULTS_FIELD_NUMBER: builtins.int
+    TEMPERATURE_FIELD_NUMBER: builtins.int
+    MAX_TOKENS_FIELD_NUMBER: builtins.int
+    partial_results: builtins.bool
+    """Enables streaming of partially generated text."""
+    @property
+    def temperature(self) -> google.protobuf.wrappers_pb2.DoubleValue:
+        """Affects creativity and randomness of responses. Should be a double number between 0 (inclusive) and 1 (inclusive).
+        Lower values produce more straightforward responses, while higher values lead to increased creativity and randomness.
+        """
+
+    @property
+    def max_tokens(self) -> google.protobuf.wrappers_pb2.Int64Value:
+        """Sets the maximum limit on the total number of tokens used for both the input prompt and the generated response.
+        Must be greater than zero and not exceed 7400 tokens.
+        """
+
+    def __init__(
+        self,
+        *,
+        partial_results: builtins.bool = ...,
+        temperature: google.protobuf.wrappers_pb2.DoubleValue | None = ...,
+        max_tokens: google.protobuf.wrappers_pb2.Int64Value | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["max_tokens", b"max_tokens", "temperature", b"temperature"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["max_tokens", b"max_tokens", "partial_results", b"partial_results", "temperature", b"temperature"]) -> None: ...
+
+global___GenerationOptions = GenerationOptions
+
+@typing.final
+class Alternative(google.protobuf.message.Message):
+    """Represents an alternative generated response, including its score and token count."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    TEXT_FIELD_NUMBER: builtins.int
+    SCORE_FIELD_NUMBER: builtins.int
+    NUM_TOKENS_FIELD_NUMBER: builtins.int
+    text: builtins.str
+    """The generated text response."""
+    score: builtins.float
+    """The score or confidence of the generated text."""
+    num_tokens: builtins.int
+    """The number of tokens in the generated response."""
+    def __init__(
+        self,
+        *,
+        text: builtins.str = ...,
+        score: builtins.float = ...,
+        num_tokens: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["num_tokens", b"num_tokens", "score", b"score", "text", b"text"]) -> None: ...
+
+global___Alternative = Alternative
+
+@typing.final
+class Message(google.protobuf.message.Message):
+    """Represents a message within a chat."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROLE_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+    role: builtins.str
+    """Identifies the sender of the message."""
+    text: builtins.str
+    """The text content of the message."""
+    def __init__(
+        self,
+        *,
+        role: builtins.str = ...,
+        text: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["role", b"role", "text", b"text"]) -> None: ...
+
+global___Message = Message
+
+@typing.final
+class Token(google.protobuf.message.Message):
+    """Represents a token, the basic unit of text, used by the LLM."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ID_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+    SPECIAL_FIELD_NUMBER: builtins.int
+    id: builtins.int
+    """An internal token identifier."""
+    text: builtins.str
+    """The textual representation of the token."""
+    special: builtins.bool
+    """Indicates whether the token is special or not. Special tokens define the model's behavior and are not visible to users."""
+    def __init__(
+        self,
+        *,
+        id: builtins.int = ...,
+        text: builtins.str = ...,
+        special: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["id", b"id", "special", b"special", "text", b"text"]) -> None: ...
+
+global___Token = Token