c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python 0.1.0a6__py3-none-any.whl → 0.1.0a7__py3-none-any.whl

gradientai/types/agents/chat/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .completion_create_params import CompletionCreateParams as CompletionCreateParams
+from .completion_create_response import CompletionCreateResponse as CompletionCreateResponse

gradientai/types/agents/chat/completion_create_params.py

@@ -0,0 +1,185 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+__all__ = [
+    "CompletionCreateParams",
+    "Message",
+    "MessageChatCompletionRequestSystemMessage",
+    "MessageChatCompletionRequestDeveloperMessage",
+    "MessageChatCompletionRequestUserMessage",
+    "MessageChatCompletionRequestAssistantMessage",
+    "StreamOptions",
+]
+
+
+class CompletionCreateParams(TypedDict, total=False):
+    messages: Required[Iterable[Message]]
+    """A list of messages comprising the conversation so far."""
+
+    model: Required[str]
+    """Model ID used to generate the response."""
+
+    frequency_penalty: Optional[float]
+    """Number between -2.0 and 2.0.
+
+    Positive values penalize new tokens based on their existing frequency in the
+    text so far, decreasing the model's likelihood to repeat the same line verbatim.
+    """
+
+    logit_bias: Optional[Dict[str, int]]
+    """Modify the likelihood of specified tokens appearing in the completion.
+
+    Accepts a JSON object that maps tokens (specified by their token ID in the
+    tokenizer) to an associated bias value from -100 to 100. Mathematically, the
+    bias is added to the logits generated by the model prior to sampling. The exact
+    effect will vary per model, but values between -1 and 1 should decrease or
+    increase likelihood of selection; values like -100 or 100 should result in a ban
+    or exclusive selection of the relevant token.
+    """
+
+    logprobs: Optional[bool]
+    """Whether to return log probabilities of the output tokens or not.
+
+    If true, returns the log probabilities of each output token returned in the
+    `content` of `message`.
+    """
+
+    max_completion_tokens: Optional[int]
+    """
+    The maximum number of completion tokens that may be used over the course of the
+    run. The run will make a best effort to use only the number of completion tokens
+    specified, across multiple turns of the run.
+    """
+
+    max_tokens: Optional[int]
+    """The maximum number of tokens that can be generated in the completion.
+
+    The token count of your prompt plus `max_tokens` cannot exceed the model's
+    context length.
+    """
+
+    metadata: Optional[Dict[str, str]]
+    """Set of 16 key-value pairs that can be attached to an object.
+
+    This can be useful for storing additional information about the object in a
+    structured format, and querying for objects via API or the dashboard.
+
+    Keys are strings with a maximum length of 64 characters. Values are strings with
+    a maximum length of 512 characters.
+    """
+
+    n: Optional[int]
+    """How many chat completion choices to generate for each input message.
+
+    Note that you will be charged based on the number of generated tokens across all
+    of the choices. Keep `n` as `1` to minimize costs.
+    """
+
+    presence_penalty: Optional[float]
+    """Number between -2.0 and 2.0.
+
+    Positive values penalize new tokens based on whether they appear in the text so
+    far, increasing the model's likelihood to talk about new topics.
+    """
+
+    stop: Union[Optional[str], List[str], None]
+    """Up to 4 sequences where the API will stop generating further tokens.
+
+    The returned text will not contain the stop sequence.
+    """
+
+    stream: Optional[bool]
+    """
+    If set to true, the model response data will be streamed to the client as it is
+    generated using server-sent events.
+    """
+
+    stream_options: Optional[StreamOptions]
+    """Options for streaming response. Only set this when you set `stream: true`."""
+
+    temperature: Optional[float]
+    """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_logprobs: Optional[int]
+    """
+    An integer between 0 and 20 specifying the number of most likely tokens to
+    return at each token position, each with an associated log probability.
+    `logprobs` must be set to `true` if this parameter is used.
+    """
+
+    top_p: Optional[float]
+    """
+    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.
+    """
+
+    user: str
+    """
+    A unique identifier representing your end-user, which can help DigitalOcean to
+    monitor and detect abuse.
+    """
+
+
+class MessageChatCompletionRequestSystemMessage(TypedDict, total=False):
+    content: Required[Union[str, List[str]]]
+    """The contents of the system message."""
+
+    role: Required[Literal["system"]]
+    """The role of the messages author, in this case `system`."""
+
+
+class MessageChatCompletionRequestDeveloperMessage(TypedDict, total=False):
+    content: Required[Union[str, List[str]]]
+    """The contents of the developer message."""
+
+    role: Required[Literal["developer"]]
+    """The role of the messages author, in this case `developer`."""
+
+
+class MessageChatCompletionRequestUserMessage(TypedDict, total=False):
+    content: Required[Union[str, List[str]]]
+    """The contents of the user message."""
+
+    role: Required[Literal["user"]]
+    """The role of the messages author, in this case `user`."""
+
+
+class MessageChatCompletionRequestAssistantMessage(TypedDict, total=False):
+    role: Required[Literal["assistant"]]
+    """The role of the messages author, in this case `assistant`."""
+
+    content: Union[str, List[str], None]
+    """The contents of the assistant message."""
+
+
+Message: TypeAlias = Union[
+    MessageChatCompletionRequestSystemMessage,
+    MessageChatCompletionRequestDeveloperMessage,
+    MessageChatCompletionRequestUserMessage,
+    MessageChatCompletionRequestAssistantMessage,
+]
+
+
+class StreamOptions(TypedDict, total=False):
+    include_usage: bool
+    """If set, an additional chunk will be streamed before the `data: [DONE]` message.
+
+    The `usage` field on this chunk shows the token usage statistics for the entire
+    request, and the `choices` field will always be an empty array.
+
+    All other chunks will also include a `usage` field, but with a null value.
+    **NOTE:** If the stream is interrupted, you may not receive the final usage
+    chunk which contains the total token usage for the request.
+    """

gradientai/types/agents/chat/completion_create_response.py

@@ -0,0 +1,81 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+from ...shared.chat_completion_token_logprob import ChatCompletionTokenLogprob
+
+__all__ = ["CompletionCreateResponse", "Choice", "ChoiceLogprobs", "ChoiceMessage", "Usage"]
+
+
+class ChoiceLogprobs(BaseModel):
+    content: Optional[List[ChatCompletionTokenLogprob]] = None
+    """A list of message content tokens with log probability information."""
+
+    refusal: Optional[List[ChatCompletionTokenLogprob]] = None
+    """A list of message refusal tokens with log probability information."""
+
+
+class ChoiceMessage(BaseModel):
+    content: Optional[str] = None
+    """The contents of the message."""
+
+    refusal: Optional[str] = None
+    """The refusal message generated by the model."""
+
+    role: Literal["assistant"]
+    """The role of the author of this message."""
+
+
+class Choice(BaseModel):
+    finish_reason: Literal["stop", "length"]
+    """The reason the model stopped generating tokens.
+
+    This will be `stop` if the model hit a natural stop point or a provided stop
+    sequence, or `length` if the maximum number of tokens specified in the request
+    was reached.
+    """
+
+    index: int
+    """The index of the choice in the list of choices."""
+
+    logprobs: Optional[ChoiceLogprobs] = None
+    """Log probability information for the choice."""
+
+    message: ChoiceMessage
+    """A chat completion message generated by the model."""
+
+
+class Usage(BaseModel):
+    completion_tokens: int
+    """Number of tokens in the generated completion."""
+
+    prompt_tokens: int
+    """Number of tokens in the prompt."""
+
+    total_tokens: int
+    """Total number of tokens used in the request (prompt + completion)."""
+
+
+class CompletionCreateResponse(BaseModel):
+    id: str
+    """A unique identifier for the chat completion."""
+
+    choices: List[Choice]
+    """A list of chat completion choices.
+
+    Can be more than one if `n` is greater than 1.
+    """
+
+    created: int
+    """The Unix timestamp (in seconds) of when the chat completion was created."""
+
+    model: str
+    """The model used for the chat completion."""
+
+    object: Literal["chat.completion"]
+    """The object type, which is always `chat.completion`."""
+
+    usage: Optional[Usage] = None
+    """Usage statistics for the completion request."""

gradientai/types/api_model.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .api_agreement import APIAgreement
+from .api_model_version import APIModelVersion
+
+__all__ = ["APIModel"]
+
+
+class APIModel(BaseModel):
+    agreement: Optional[APIAgreement] = None
+
+    created_at: Optional[datetime] = None
+
+    is_foundational: Optional[bool] = None
+
+    name: Optional[str] = None
+
+    parent_uuid: Optional[str] = None
+
+    updated_at: Optional[datetime] = None
+
+    upload_complete: Optional[bool] = None
+
+    url: Optional[str] = None
+
+    uuid: Optional[str] = None
+
+    version: Optional[APIModelVersion] = None

gradientai/types/chat/__init__.py

@@ -4,4 +4,3 @@ from __future__ import annotations
 
 from .completion_create_params import CompletionCreateParams as CompletionCreateParams
 from .completion_create_response import CompletionCreateResponse as CompletionCreateResponse
-from .chat_completion_token_logprob import ChatCompletionTokenLogprob as ChatCompletionTokenLogprob

gradientai/types/chat/completion_create_response.py

@@ -4,7 +4,7 @@ from typing import List, Optional
 from typing_extensions import Literal
 
 from ..._models import BaseModel
-from .chat_completion_token_logprob import ChatCompletionTokenLogprob
+from ..shared.chat_completion_token_logprob import ChatCompletionTokenLogprob
 
 __all__ = ["CompletionCreateResponse", "Choice", "ChoiceLogprobs", "ChoiceMessage", "Usage"]
 

gradientai/types/model_list_params.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["ModelListParams"]
+
+
+class ModelListParams(TypedDict, total=False):
+    page: int
+    """page number."""
+
+    per_page: int
+    """items per page."""
+
+    public_only: bool
+    """only include models that are publicly available."""
+
+    usecases: List[
+        Literal[
+            "MODEL_USECASE_UNKNOWN",
+            "MODEL_USECASE_AGENT",
+            "MODEL_USECASE_FINETUNED",
+            "MODEL_USECASE_KNOWLEDGEBASE",
+            "MODEL_USECASE_GUARDRAIL",
+            "MODEL_USECASE_REASONING",
+            "MODEL_USECASE_SERVERLESS",
+        ]
+    ]
+    """include only models defined for the listed usecases.
+
+    - MODEL_USECASE_UNKNOWN: The use case of the model is unknown
+    - MODEL_USECASE_AGENT: The model maybe used in an agent
+    - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning
+    - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases
+      (embedding models)
+    - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails
+    - MODEL_USECASE_REASONING: The model usecase for reasoning
+    - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference
+    """

gradientai/types/model_list_response.py

@@ -1,15 +1,18 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List
-from typing_extensions import Literal
+from typing import List, Optional
 
-from .model import Model
 from .._models import BaseModel
+from .api_model import APIModel
+from .shared.api_meta import APIMeta
+from .shared.api_links import APILinks
 
 __all__ = ["ModelListResponse"]
 
 
 class ModelListResponse(BaseModel):
-    data: List[Model]
+    links: Optional[APILinks] = None
 
-    object: Literal["list"]
+    meta: Optional[APIMeta] = None
+
+    models: Optional[List[APIModel]] = None

gradientai/types/shared/__init__.py

@@ -2,3 +2,4 @@
 
 from .api_meta import APIMeta as APIMeta
 from .api_links import APILinks as APILinks
+from .chat_completion_token_logprob import ChatCompletionTokenLogprob as ChatCompletionTokenLogprob

gradientai/types/model.py

@@ -1,21 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing_extensions import Literal
-
-from .._models import BaseModel
-
-__all__ = ["Model"]
-
-
-class Model(BaseModel):
-    id: str
-    """The model identifier, which can be referenced in the API endpoints."""
-
-    created: int
-    """The Unix timestamp (in seconds) when the model was created."""
-
-    object: Literal["model"]
-    """The object type, which is always "model"."""
-
-    owned_by: str
-    """The organization that owns the model."""