feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 52
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-17bdb8a33fb4fcade827bba868bd65cd30c64b1d09b4a6d83c3e37a8439ed37f.yml
 openapi_spec_hash: bc325b52f3b20d8c56e0be5de88f2dc3
-config_hash: f0c8dfba598e8ad313dc6b95c7b34df6
+config_hash: 1ecef0ff4fd125bbc00eec65e3dd4798

api.md

@@ -50,9 +50,14 @@ Types:
 ```python
 from contextual.types import (
     Agent,
+    AgentConfigs,
     AgentMetadata,
     CreateAgentOutput,
+    FilterAndRerankConfig,
+    GenerateResponseConfig,
+    GlobalConfig,
     ListAgentsResponse,
+    RetrievalConfig,
     AgentUpdateResponse,
     AgentDeleteResponse,
     AgentMetadataResponse,

src/contextual/resources/agents/agents.py

@@ -52,6 +52,7 @@
     EvaluateResourceWithStreamingResponse,
     AsyncEvaluateResourceWithStreamingResponse,
 )
+from ...types.agent_configs_param import AgentConfigsParam
 from ...types.create_agent_output import CreateAgentOutput
 from ...types.agent_metadata_response import AgentMetadataResponse
 
@@ -98,7 +99,7 @@ def create(
         self,
         *,
         name: str,
-        agent_configs: agent_create_params.AgentConfigs | NotGiven = NOT_GIVEN,
+        agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
         datastore_ids: List[str] | NotGiven = NOT_GIVEN,
         description: str | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
@@ -186,7 +187,7 @@ def update(
         self,
         agent_id: str,
         *,
-        agent_configs: agent_update_params.AgentConfigs | NotGiven = NOT_GIVEN,
+        agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
         datastore_ids: List[str] | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
         llm_model_id: str | NotGiven = NOT_GIVEN,
@@ -464,7 +465,7 @@ async def create(
         self,
         *,
         name: str,
-        agent_configs: agent_create_params.AgentConfigs | NotGiven = NOT_GIVEN,
+        agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
         datastore_ids: List[str] | NotGiven = NOT_GIVEN,
         description: str | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
@@ -552,7 +553,7 @@ async def update(
         self,
         agent_id: str,
         *,
-        agent_configs: agent_update_params.AgentConfigs | NotGiven = NOT_GIVEN,
+        agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
         datastore_ids: List[str] | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
         llm_model_id: str | NotGiven = NOT_GIVEN,

src/contextual/types/__init__.py

@@ -4,17 +4,22 @@
 
 from .agent import Agent as Agent
 from .datastore import Datastore as Datastore
+from .agent_configs import AgentConfigs as AgentConfigs
+from .global_config import GlobalConfig as GlobalConfig
 from .agent_metadata import AgentMetadata as AgentMetadata
 from .new_user_param import NewUserParam as NewUserParam
+from .retrieval_config import RetrievalConfig as RetrievalConfig
 from .user_list_params import UserListParams as UserListParams
 from .agent_list_params import AgentListParams as AgentListParams
 from .parse_jobs_params import ParseJobsParams as ParseJobsParams
 from .datastore_metadata import DatastoreMetadata as DatastoreMetadata
 from .user_invite_params import UserInviteParams as UserInviteParams
 from .user_update_params import UserUpdateParams as UserUpdateParams
+from .agent_configs_param import AgentConfigsParam as AgentConfigsParam
 from .agent_create_params import AgentCreateParams as AgentCreateParams
 from .agent_update_params import AgentUpdateParams as AgentUpdateParams
 from .create_agent_output import CreateAgentOutput as CreateAgentOutput
+from .global_config_param import GlobalConfigParam as GlobalConfigParam
 from .list_users_response import ListUsersResponse as ListUsersResponse
 from .parse_create_params import ParseCreateParams as ParseCreateParams
 from .parse_jobs_response import ParseJobsResponse as ParseJobsResponse
@@ -27,12 +32,17 @@
 from .generate_create_params import GenerateCreateParams as GenerateCreateParams
 from .lmunit_create_response import LMUnitCreateResponse as LMUnitCreateResponse
 from .rerank_create_response import RerankCreateResponse as RerankCreateResponse
+from .retrieval_config_param import RetrievalConfigParam as RetrievalConfigParam
 from .user_deactivate_params import UserDeactivateParams as UserDeactivateParams
 from .agent_metadata_response import AgentMetadataResponse as AgentMetadataResponse
 from .datastore_create_params import DatastoreCreateParams as DatastoreCreateParams
+from .filter_and_rerank_config import FilterAndRerankConfig as FilterAndRerankConfig
 from .generate_create_response import GenerateCreateResponse as GenerateCreateResponse
+from .generate_response_config import GenerateResponseConfig as GenerateResponseConfig
 from .list_datastores_response import ListDatastoresResponse as ListDatastoresResponse
 from .parse_job_results_params import ParseJobResultsParams as ParseJobResultsParams
 from .create_datastore_response import CreateDatastoreResponse as CreateDatastoreResponse
 from .parse_job_status_response import ParseJobStatusResponse as ParseJobStatusResponse
 from .parse_job_results_response import ParseJobResultsResponse as ParseJobResultsResponse
+from .filter_and_rerank_config_param import FilterAndRerankConfigParam as FilterAndRerankConfigParam
+from .generate_response_config_param import GenerateResponseConfigParam as GenerateResponseConfigParam

src/contextual/types/agent_configs.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .global_config import GlobalConfig
+from .retrieval_config import RetrievalConfig
+from .filter_and_rerank_config import FilterAndRerankConfig
+from .generate_response_config import GenerateResponseConfig
+
+__all__ = ["AgentConfigs"]
+
+
+class AgentConfigs(BaseModel):
+    filter_and_rerank_config: Optional[FilterAndRerankConfig] = None
+    """Parameters that affect filtering and reranking of retrieved knowledge"""
+
+    generate_response_config: Optional[GenerateResponseConfig] = None
+    """Parameters that affect response generation"""
+
+    global_config: Optional[GlobalConfig] = None
+    """Parameters that affect the agent's overall RAG workflow"""
+
+    retrieval_config: Optional[RetrievalConfig] = None
+    """Parameters that affect how the agent retrieves from datastore(s)"""

src/contextual/types/agent_configs_param.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .global_config_param import GlobalConfigParam
+from .retrieval_config_param import RetrievalConfigParam
+from .filter_and_rerank_config_param import FilterAndRerankConfigParam
+from .generate_response_config_param import GenerateResponseConfigParam
+
+__all__ = ["AgentConfigsParam"]
+
+
+class AgentConfigsParam(TypedDict, total=False):
+    filter_and_rerank_config: FilterAndRerankConfigParam
+    """Parameters that affect filtering and reranking of retrieved knowledge"""
+
+    generate_response_config: GenerateResponseConfigParam
+    """Parameters that affect response generation"""
+
+    global_config: GlobalConfigParam
+    """Parameters that affect the agent's overall RAG workflow"""
+
+    retrieval_config: RetrievalConfigParam
+    """Parameters that affect how the agent retrieves from datastore(s)"""

src/contextual/types/agent_create_params.py

@@ -5,21 +5,16 @@
 from typing import List
 from typing_extensions import Required, TypedDict
 
-__all__ = [
-    "AgentCreateParams",
-    "AgentConfigs",
-    "AgentConfigsFilterAndRerankConfig",
-    "AgentConfigsGenerateResponseConfig",
-    "AgentConfigsGlobalConfig",
-    "AgentConfigsRetrievalConfig",
-]
+from .agent_configs_param import AgentConfigsParam
+
+__all__ = ["AgentCreateParams"]
 
 
 class AgentCreateParams(TypedDict, total=False):
     name: Required[str]
     """Name of the agent"""
 
-    agent_configs: AgentConfigs
+    agent_configs: AgentConfigsParam
     """The following advanced parameters are experimental and subject to change."""
 
     datastore_ids: List[str]
@@ -54,116 +49,3 @@ class AgentCreateParams(TypedDict, total=False):
     Note that we do not guarantee that the system will follow these instructions
     exactly.
     """
-
-
-class AgentConfigsFilterAndRerankConfig(TypedDict, total=False):
-    rerank_instructions: str
-    """Instructions that the reranker references when ranking retrievals.
-
-    Note that we do not guarantee that the reranker will follow these instructions
-    exactly. Examples: "Prioritize internal sales documents over market analysis
-    reports. More recent documents should be weighted higher. Enterprise portal
-    content supersedes distributor communications." and "Emphasize forecasts from
-    top-tier investment banks. Recent analysis should take precedence. Disregard
-    aggregator sites and favor detailed research notes over news summaries."
-    """
-
-    reranker_score_filter_threshold: float
-    """
-    If the reranker relevance score associated with a chunk is below this threshold,
-    then the chunk will be filtered out and not used for generation. Scores are
-    between 0 and 1, with scores closer to 1 being more relevant. Set the value to 0
-    to disable the reranker score filtering.
-    """
-
-    top_k_reranked_chunks: int
-    """The number of highest ranked chunks after reranking to be used"""
-
-
-class AgentConfigsGenerateResponseConfig(TypedDict, total=False):
-    avoid_commentary: bool
-    """
-    Flag to indicate whether the model should avoid providing additional commentary
-    in responses. Commentary is conversational in nature and does not contain
-    verifiable claims; therefore, commentary is not strictly grounded in available
-    context. However, commentary may provide useful context which improves the
-    helpfulness of responses.
-    """
-
-    calculate_groundedness: bool
-    """This parameter controls generation of groundedness scores."""
-
-    frequency_penalty: float
-    """
-    This parameter adjusts how the model treats repeated tokens during text
-    generation.
-    """
-
-    max_new_tokens: int
-    """The maximum number of tokens the model can generate in a response."""
-
-    seed: int
-    """
-    This parameter controls the randomness of how the model selects the next tokens
-    during text generation.
-    """
-
-    temperature: float
-    """The sampling temperature, which affects the randomness in the response."""
-
-    top_p: float
-    """
-    A parameter for nucleus sampling, an alternative to `temperature` which also
-    affects the randomness of the response.
-    """
-
-
-class AgentConfigsGlobalConfig(TypedDict, total=False):
-    enable_filter: bool
-    """Enables filtering of retrieved chunks with a separate LLM"""
-
-    enable_multi_turn: bool
-    """Enables multi-turn conversations.
-
-    This feature is currently experimental and will be improved.
-    """
-
-    enable_rerank: bool
-    """Enables reranking of retrieved chunks"""
-
-    should_check_retrieval_need: bool
-    """Enables checking if retrieval is needed for the query.
-
-    This feature is currently experimental and will be improved.
-    """
-
-
-class AgentConfigsRetrievalConfig(TypedDict, total=False):
-    lexical_alpha: float
-    """The weight of lexical search during retrieval.
-
-    Must sum to 1 with semantic_alpha.
-    """
-
-    semantic_alpha: float
-    """The weight of semantic search during retrieval.
-
-    Must sum to 1 with lexical_alpha.
-    """
-
-    top_k_retrieved_chunks: int
-    """The maximum number of retrieved chunks from the datastore."""
-
-
-class AgentConfigs(TypedDict, total=False):
-    filter_and_rerank_config: AgentConfigsFilterAndRerankConfig
-    """Parameters that affect filtering and reranking of retrieved knowledge"""
-
-    generate_response_config: AgentConfigsGenerateResponseConfig
-    """Parameters that affect response generation"""
-
-    global_config: AgentConfigsGlobalConfig
-    """Parameters that affect the agent's overall RAG workflow"""
-
-    retrieval_config: AgentConfigsRetrievalConfig
-    """Parameters that affect how the agent retrieves from datastore(s)"""