c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python 0.1.0a3__py3-none-any.whl

digitalocean_genai_sdk/types/chat_create_completion_params.py

@@ -0,0 +1,208 @@
+# 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
+
+from .chat_completion_request_message_content_part_text_param import ChatCompletionRequestMessageContentPartTextParam
+
+__all__ = [
+    "ChatCreateCompletionParams",
+    "Message",
+    "MessageChatCompletionRequestSystemMessage",
+    "MessageChatCompletionRequestDeveloperMessage",
+    "MessageChatCompletionRequestUserMessage",
+    "MessageChatCompletionRequestAssistantMessage",
+    "MessageChatCompletionRequestAssistantMessageContentArrayOfContentPart",
+    "MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartChatCompletionRequestMessageContentPartRefusal",
+    "StreamOptions",
+]
+
+
+class ChatCreateCompletionParams(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, Iterable[ChatCompletionRequestMessageContentPartTextParam]]]
+    """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, Iterable[ChatCompletionRequestMessageContentPartTextParam]]]
+    """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, Iterable[ChatCompletionRequestMessageContentPartTextParam]]]
+    """The contents of the user message."""
+
+    role: Required[Literal["user"]]
+    """The role of the messages author, in this case `user`."""
+
+
+class MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartChatCompletionRequestMessageContentPartRefusal(
+    TypedDict, total=False
+):
+    refusal: Required[str]
+    """The refusal message generated by the model."""
+
+    type: Required[Literal["refusal"]]
+    """The type of the content part."""
+
+
+MessageChatCompletionRequestAssistantMessageContentArrayOfContentPart: TypeAlias = Union[
+    ChatCompletionRequestMessageContentPartTextParam,
+    MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartChatCompletionRequestMessageContentPartRefusal,
+]
+
+
+class MessageChatCompletionRequestAssistantMessage(TypedDict, total=False):
+    role: Required[Literal["assistant"]]
+    """The role of the messages author, in this case `assistant`."""
+
+    content: Union[str, Iterable[MessageChatCompletionRequestAssistantMessageContentArrayOfContentPart], None]
+    """The contents of the assistant message."""
+
+    refusal: Optional[str]
+    """The refusal message by the assistant."""
+
+
+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.
+    """

digitalocean_genai_sdk/types/chat_create_completion_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 .chat_completion_token_logprob import ChatCompletionTokenLogprob
+
+__all__ = ["ChatCreateCompletionResponse", "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 ChatCreateCompletionResponse(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."""

digitalocean_genai_sdk/types/embedding_create_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from typing_extensions import Required, TypedDict
+
+__all__ = ["EmbeddingCreateParams"]
+
+
+class EmbeddingCreateParams(TypedDict, total=False):
+    input: Required[Union[str, List[str]]]
+    """Input text to embed, encoded as a string or array of tokens.
+
+    To embed multiple inputs in a single request, pass an array of strings.
+    """
+
+    model: Required[str]
+    """ID of the model to use.
+
+    You can use the List models API to see all of your available models.
+    """
+
+    user: str
+    """
+    A unique identifier representing your end-user, which can help DigitalOcean to
+    monitor and detect abuse.
+    """

digitalocean_genai_sdk/types/embedding_create_response.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["EmbeddingCreateResponse", "Data", "Usage"]
+
+
+class Data(BaseModel):
+    embedding: List[float]
+    """The embedding vector, which is a list of floats."""
+
+    index: int
+    """The index of the embedding in the list of embeddings."""
+
+    object: Literal["embedding"]
+    """The object type, which is always "embedding"."""
+
+
+class Usage(BaseModel):
+    prompt_tokens: int
+    """The number of tokens used by the prompt."""
+
+    total_tokens: int
+    """The total number of tokens used by the request."""
+
+
+class EmbeddingCreateResponse(BaseModel):
+    data: List[Data]
+    """The list of embeddings generated by the model."""
+
+    model: str
+    """The name of the model used to generate the embedding."""
+
+    object: Literal["list"]
+    """The object type, which is always "list"."""
+
+    usage: Usage
+    """The usage information for the request."""

digitalocean_genai_sdk/types/indexing_job_create_params.py

@@ -0,0 +1,14 @@
+# 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 TypedDict
+
+__all__ = ["IndexingJobCreateParams"]
+
+
+class IndexingJobCreateParams(TypedDict, total=False):
+    data_source_uuids: List[str]
+
+    knowledge_base_uuid: str

digitalocean_genai_sdk/types/indexing_job_create_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .api_indexing_job import APIIndexingJob
+
+__all__ = ["IndexingJobCreateResponse"]
+
+
+class IndexingJobCreateResponse(BaseModel):
+    job: Optional[APIIndexingJob] = None

digitalocean_genai_sdk/types/indexing_job_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["IndexingJobListParams"]
+
+
+class IndexingJobListParams(TypedDict, total=False):
+    page: int
+    """page number."""
+
+    per_page: int
+    """items per page."""

digitalocean_genai_sdk/types/indexing_job_list_response.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .agents.api_meta import APIMeta
+from .agents.api_links import APILinks
+from .api_indexing_job import APIIndexingJob
+
+__all__ = ["IndexingJobListResponse"]
+
+
+class IndexingJobListResponse(BaseModel):
+    jobs: Optional[List[APIIndexingJob]] = None
+
+    links: Optional[APILinks] = None
+
+    meta: Optional[APIMeta] = None

digitalocean_genai_sdk/types/indexing_job_retrieve_data_sources_response.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["IndexingJobRetrieveDataSourcesResponse", "IndexedDataSource"]
+
+
+class IndexedDataSource(BaseModel):
+    completed_at: Optional[datetime] = None
+
+    data_source_uuid: Optional[str] = None
+
+    error_details: Optional[str] = None
+
+    error_msg: Optional[str] = None
+
+    failed_item_count: Optional[str] = None
+
+    indexed_file_count: Optional[str] = None
+
+    indexed_item_count: Optional[str] = None
+
+    removed_item_count: Optional[str] = None
+
+    skipped_item_count: Optional[str] = None
+
+    started_at: Optional[datetime] = None
+
+    status: Optional[
+        Literal[
+            "DATA_SOURCE_STATUS_UNKNOWN",
+            "DATA_SOURCE_STATUS_IN_PROGRESS",
+            "DATA_SOURCE_STATUS_UPDATED",
+            "DATA_SOURCE_STATUS_PARTIALLY_UPDATED",
+            "DATA_SOURCE_STATUS_NOT_UPDATED",
+            "DATA_SOURCE_STATUS_FAILED",
+        ]
+    ] = None
+
+    total_bytes: Optional[str] = None
+
+    total_bytes_indexed: Optional[str] = None
+
+    total_file_count: Optional[str] = None
+
+
+class IndexingJobRetrieveDataSourcesResponse(BaseModel):
+    indexed_data_sources: Optional[List[IndexedDataSource]] = None

digitalocean_genai_sdk/types/indexing_job_retrieve_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .api_indexing_job import APIIndexingJob
+
+__all__ = ["IndexingJobRetrieveResponse"]
+
+
+class IndexingJobRetrieveResponse(BaseModel):
+    job: Optional[APIIndexingJob] = None

digitalocean_genai_sdk/types/indexing_job_update_cancel_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["IndexingJobUpdateCancelParams"]
+
+
+class IndexingJobUpdateCancelParams(TypedDict, total=False):
+    body_uuid: Annotated[str, PropertyInfo(alias="uuid")]
+    """A unique identifier for an indexing job."""

digitalocean_genai_sdk/types/indexing_job_update_cancel_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .api_indexing_job import APIIndexingJob
+
+__all__ = ["IndexingJobUpdateCancelResponse"]
+
+
+class IndexingJobUpdateCancelResponse(BaseModel):
+    job: Optional[APIIndexingJob] = None

digitalocean_genai_sdk/types/knowledge_base_create_params.py

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Iterable
+from typing_extensions import TypedDict
+
+from .knowledge_bases.api_spaces_data_source_param import APISpacesDataSourceParam
+from .knowledge_bases.api_file_upload_data_source_param import APIFileUploadDataSourceParam
+from .knowledge_bases.api_web_crawler_data_source_param import APIWebCrawlerDataSourceParam
+
+__all__ = ["KnowledgeBaseCreateParams", "Datasource"]
+
+
+class KnowledgeBaseCreateParams(TypedDict, total=False):
+    database_id: str
+    """
+    Identifier of the DigitalOcean OpenSearch database this knowledge base will use,
+    optional. If not provided, we create a new database for the knowledge base in
+    the same region as the knowledge base.
+    """
+
+    datasources: Iterable[Datasource]
+    """The data sources to use for this knowledge base.
+
+    See
+    [Organize Data Sources](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#spaces-buckets)
+    for more information on data sources best practices.
+    """
+
+    embedding_model_uuid: str
+    """
+    Identifier for the
+    [embedding model](https://docs.digitalocean.com/products/genai-platform/details/models/#embedding-models).
+    """
+
+    name: str
+    """Name of the knowledge base."""
+
+    project_id: str
+    """Identifier of the DigitalOcean project this knowledge base will belong to."""
+
+    region: str
+    """The datacenter region to deploy the knowledge base in."""
+
+    tags: List[str]
+    """Tags to organize your knowledge base."""
+
+    vpc_uuid: str
+
+
+class Datasource(TypedDict, total=False):
+    bucket_name: str
+
+    bucket_region: str
+
+    file_upload_data_source: APIFileUploadDataSourceParam
+    """File to upload as data source for knowledge base."""
+
+    item_path: str
+
+    spaces_data_source: APISpacesDataSourceParam
+
+    web_crawler_data_source: APIWebCrawlerDataSourceParam

digitalocean_genai_sdk/types/knowledge_base_create_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .api_knowledge_base import APIKnowledgeBase
+
+__all__ = ["KnowledgeBaseCreateResponse"]
+
+
+class KnowledgeBaseCreateResponse(BaseModel):
+    knowledge_base: Optional[APIKnowledgeBase] = None

digitalocean_genai_sdk/types/knowledge_base_delete_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["KnowledgeBaseDeleteResponse"]
+
+
+class KnowledgeBaseDeleteResponse(BaseModel):
+    uuid: Optional[str] = None

digitalocean_genai_sdk/types/knowledge_base_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["KnowledgeBaseListParams"]
+
+
+class KnowledgeBaseListParams(TypedDict, total=False):
+    page: int
+    """page number."""
+
+    per_page: int
+    """items per page."""

digitalocean_genai_sdk/types/knowledge_base_list_response.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .agents.api_meta import APIMeta
+from .agents.api_links import APILinks
+from .api_knowledge_base import APIKnowledgeBase
+
+__all__ = ["KnowledgeBaseListResponse"]
+
+
+class KnowledgeBaseListResponse(BaseModel):
+    knowledge_bases: Optional[List[APIKnowledgeBase]] = None
+
+    links: Optional[APILinks] = None
+
+    meta: Optional[APIMeta] = None

digitalocean_genai_sdk/types/knowledge_base_retrieve_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .api_knowledge_base import APIKnowledgeBase
+
+__all__ = ["KnowledgeBaseRetrieveResponse"]
+
+
+class KnowledgeBaseRetrieveResponse(BaseModel):
+    database_status: Optional[
+        Literal[
+            "CREATING",
+            "ONLINE",
+            "POWEROFF",
+            "REBUILDING",
+            "REBALANCING",
+            "DECOMMISSIONED",
+            "FORKING",
+            "MIGRATING",
+            "RESIZING",
+            "RESTORING",
+            "POWERING_ON",
+            "UNHEALTHY",
+        ]
+    ] = None
+
+    knowledge_base: Optional[APIKnowledgeBase] = None