chore: add missing docstrings

Author: stainless-app[bot]

src/gradient/types/agent_create_response.py

@@ -10,6 +10,8 @@
 
 
 class AgentCreateResponse(BaseModel):
+    """Information about a newly created Agent"""
+
     agent: Optional["APIAgent"] = None
     """An Agent"""
 

src/gradient/types/agent_delete_response.py

@@ -10,6 +10,8 @@
 
 
 class AgentDeleteResponse(BaseModel):
+    """Info about a deleted agent"""
+
     agent: Optional["APIAgent"] = None
     """An Agent"""
 

src/gradient/types/agent_list_response.py

@@ -24,6 +24,8 @@
 
 
 class AgentChatbot(BaseModel):
+    """A Chatbot"""
+
     allowed_domains: Optional[List[str]] = None
 
     button_background_color: Optional[str] = None
@@ -41,11 +43,15 @@ class AgentChatbot(BaseModel):
 
 
 class AgentChatbotIdentifier(BaseModel):
+    """Agent Chatbot Identifier"""
+
     agent_chatbot_identifier: Optional[str] = None
     """Agent chatbot identifier"""
 
 
 class AgentDeployment(BaseModel):
+    """Description of deployment"""
+
     created_at: Optional[datetime] = None
     """Creation date / time"""
 
@@ -98,6 +104,8 @@ class AgentTemplateGuardrail(BaseModel):
 
 
 class AgentTemplate(BaseModel):
+    """Represents an AgentTemplate entity"""
+
     created_at: Optional[datetime] = None
     """The agent template's creation date"""
 
@@ -157,6 +165,8 @@ class AgentTemplate(BaseModel):
 
 
 class Agent(BaseModel):
+    """A GenAI Agent's configuration"""
+
     chatbot: Optional[AgentChatbot] = None
     """A Chatbot"""
 
@@ -266,6 +276,8 @@ class Agent(BaseModel):
 
 
 class AgentListResponse(BaseModel):
+    """List of Agents"""
+
     agents: Optional[List[Agent]] = None
     """Agents"""
 

src/gradient/types/agent_retrieve_response.py

@@ -10,6 +10,8 @@
 
 
 class AgentRetrieveResponse(BaseModel):
+    """One Agent"""
+
     agent: Optional["APIAgent"] = None
     """An Agent"""
 

src/gradient/types/agent_retrieve_usage_response.py

@@ -9,12 +9,16 @@
 
 
 class LogInsightsUsageMeasurement(BaseModel):
+    """Usage Measurement Description"""
+
     tokens: Optional[int] = None
 
     usage_type: Optional[str] = None
 
 
 class LogInsightsUsage(BaseModel):
+    """Resource Usage Description"""
+
     measurements: Optional[List[LogInsightsUsageMeasurement]] = None
 
     resource_uuid: Optional[str] = None
@@ -25,12 +29,16 @@ class LogInsightsUsage(BaseModel):
 
 
 class UsageMeasurement(BaseModel):
+    """Usage Measurement Description"""
+
     tokens: Optional[int] = None
 
     usage_type: Optional[str] = None
 
 
 class Usage(BaseModel):
+    """Resource Usage Description"""
+
     measurements: Optional[List[UsageMeasurement]] = None
 
     resource_uuid: Optional[str] = None
@@ -41,6 +49,8 @@ class Usage(BaseModel):
 
 
 class AgentRetrieveUsageResponse(BaseModel):
+    """Agent usage"""
+
     log_insights_usage: Optional[LogInsightsUsage] = None
     """Resource Usage Description"""
 

src/gradient/types/agent_update_response.py

@@ -10,6 +10,8 @@
 
 
 class AgentUpdateResponse(BaseModel):
+    """Information about an updated agent"""
+
     agent: Optional["APIAgent"] = None
     """An Agent"""
 

src/gradient/types/agent_update_status_response.py

@@ -10,6 +10,8 @@
 
 
 class AgentUpdateStatusResponse(BaseModel):
+    """UpdateAgentDeploymentVisbilityOutput description"""
+
     agent: Optional["APIAgent"] = None
     """An Agent"""
 

src/gradient/types/agents/api_link_knowledge_base_output.py

@@ -10,6 +10,8 @@
 
 
 class APILinkKnowledgeBaseOutput(BaseModel):
+    """Information about a linked knowledge base"""
+
     agent: Optional["APIAgent"] = None
     """An Agent"""
 

src/gradient/types/agents/chat/completion_create_params.py

@@ -166,6 +166,8 @@ class CompletionCreateParamsBase(TypedDict, total=False):
 
 
 class MessageChatCompletionRequestSystemMessageContentArrayOfContentPartUnionMember1(TypedDict, total=False):
+    """Content part with type and text"""
+
     text: Required[str]
     """The text content"""
 
@@ -179,6 +181,11 @@ class MessageChatCompletionRequestSystemMessageContentArrayOfContentPartUnionMem
 
 
 class MessageChatCompletionRequestSystemMessage(TypedDict, total=False):
+    """
+    System-provided instructions that the model should follow, regardless of
+    messages sent by the user.
+    """
+
     content: Required[Union[str, SequenceNotStr[MessageChatCompletionRequestSystemMessageContentArrayOfContentPart]]]
     """The contents of the system message."""
 
@@ -187,6 +194,8 @@ class MessageChatCompletionRequestSystemMessage(TypedDict, total=False):
 
 
 class MessageChatCompletionRequestDeveloperMessageContentArrayOfContentPartUnionMember1(TypedDict, total=False):
+    """Content part with type and text"""
+
     text: Required[str]
     """The text content"""
 
@@ -200,6 +209,11 @@ class MessageChatCompletionRequestDeveloperMessageContentArrayOfContentPartUnion
 
 
 class MessageChatCompletionRequestDeveloperMessage(TypedDict, total=False):
+    """
+    Developer-provided instructions that the model should follow, regardless of
+    messages sent by the user.
+    """
+
     content: Required[Union[str, SequenceNotStr[MessageChatCompletionRequestDeveloperMessageContentArrayOfContentPart]]]
     """The contents of the developer message."""
 
@@ -208,6 +222,8 @@ class MessageChatCompletionRequestDeveloperMessage(TypedDict, total=False):
 
 
 class MessageChatCompletionRequestUserMessageContentArrayOfContentPartUnionMember1(TypedDict, total=False):
+    """Content part with type and text"""
+
     text: Required[str]
     """The text content"""
 
@@ -221,6 +237,11 @@ class MessageChatCompletionRequestUserMessageContentArrayOfContentPartUnionMembe
 
 
 class MessageChatCompletionRequestUserMessage(TypedDict, total=False):
+    """
+    Messages sent by an end user, containing prompts or additional context
+    information.
+    """
+
     content: Required[Union[str, SequenceNotStr[MessageChatCompletionRequestUserMessageContentArrayOfContentPart]]]
     """The contents of the user message."""
 
@@ -229,6 +250,8 @@ class MessageChatCompletionRequestUserMessage(TypedDict, total=False):
 
 
 class MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartUnionMember1(TypedDict, total=False):
+    """Content part with type and text"""
+
     text: Required[str]
     """The text content"""
 
@@ -242,6 +265,8 @@ class MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartUnion
 
 
 class MessageChatCompletionRequestAssistantMessageToolCallFunction(TypedDict, total=False):
+    """The function that the model called."""
+
     arguments: Required[str]
     """
     The arguments to call the function with, as generated by the model in JSON
@@ -266,6 +291,8 @@ class MessageChatCompletionRequestAssistantMessageToolCall(TypedDict, total=Fals
 
 
 class MessageChatCompletionRequestAssistantMessage(TypedDict, total=False):
+    """Messages sent by the model in response to user messages."""
+
     role: Required[Literal["assistant"]]
     """The role of the messages author, in this case `assistant`."""
 
@@ -297,6 +324,8 @@ class MessageChatCompletionRequestToolMessage(TypedDict, total=False):
 
 
 class StreamOptions(TypedDict, total=False):
+    """Options for streaming response. Only set this when you set `stream: true`."""
+
     include_usage: bool
     """If set, an additional chunk will be streamed before the `data: [DONE]` message.
 
@@ -315,6 +344,11 @@ class ToolChoiceChatCompletionNamedToolChoiceFunction(TypedDict, total=False):
 
 
 class ToolChoiceChatCompletionNamedToolChoice(TypedDict, total=False):
+    """Specifies a tool the model should use.
+
+    Use to force the model to call a specific function.
+    """
+
     function: Required[ToolChoiceChatCompletionNamedToolChoiceFunction]
 
     type: Required[Literal["function"]]

src/gradient/types/agents/chat/completion_create_response.py

@@ -18,6 +18,8 @@
 
 
 class ChoiceLogprobs(BaseModel):
+    """Log probability information for the choice."""
+
     content: Optional[List[ChatCompletionTokenLogprob]] = None
     """A list of message content tokens with log probability information."""
 
@@ -26,6 +28,8 @@ class ChoiceLogprobs(BaseModel):
 
 
 class ChoiceMessageToolCallFunction(BaseModel):
+    """The function that the model called."""
+
     arguments: str
     """
     The arguments to call the function with, as generated by the model in JSON
@@ -50,6 +54,8 @@ class ChoiceMessageToolCall(BaseModel):
 
 
 class ChoiceMessage(BaseModel):
+    """A chat completion message generated by the model."""
+
     content: Optional[str] = None
     """The contents of the message."""
 
@@ -86,6 +92,10 @@ class Choice(BaseModel):
 
 
 class CompletionCreateResponse(BaseModel):
+    """
+    Represents a chat completion response returned by model, based on the provided input.
+    """
+
     id: str
     """A unique identifier for the chat completion."""