feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 29
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-fa5c7cd62da1c7cb2eddf8c6bb1f32ca7f958be5c3c315ade6ca0a669814d75a.yml
-openapi_spec_hash: 8358c1a467ab971afd59d615d1e731ee
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-b075e5704110b3c03bd81b41f62b836d7624eceed7feb0ac63720dec9a4cbba4.yml
+openapi_spec_hash: 5efb926e6e99163e3e42a98986da8335
 config_hash: ff35e224e809656528c44163aa41bebd

src/Monitors/MonitorCreateParams/ChangeDetection/MonitorsSemanticChangeDetection.php

@@ -10,10 +10,10 @@
 use ContextDev\Core\Contracts\BaseModel;
 
 /**
- * Detect meaning-level changes that match a natural language query.
+ * Detect meaning-level changes to the extracted data, ignoring cosmetic or paraphrase-only differences. What is watched is determined by the extract target's `schema` and `instructions`.
  *
  * @phpstan-type MonitorsSemanticChangeDetectionShape = array{
- *   query: string, type: 'semantic', confidenceThreshold?: float|null
+ *   type: 'semantic', confidenceThreshold?: float|null
  * }
  */
 final class MonitorsSemanticChangeDetection implements BaseModel
@@ -25,26 +25,9 @@ final class MonitorsSemanticChangeDetection implements BaseModel
     #[Required]
     public string $type = 'semantic';
 
-    #[Required]
-    public string $query;
-
     #[Optional('confidence_threshold')]
     public ?float $confidenceThreshold;
 
-    /**
-     * `new MonitorsSemanticChangeDetection()` is missing required properties by the API.
-     *
-     * To enforce required parameters use
-     * ```
-     * MonitorsSemanticChangeDetection::with(query: ...)
-     * ```
-     *
-     * Otherwise ensure the following setters are called
-     *
-     * ```
-     * (new MonitorsSemanticChangeDetection)->withQuery(...)
-     * ```
-     */
     public function __construct()
     {
         $this->initialize();
@@ -55,27 +38,15 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      */
-    public static function with(
-        string $query,
-        ?float $confidenceThreshold = null
-    ): self {
+    public static function with(?float $confidenceThreshold = null): self
+    {
         $self = new self;
 
-        $self['query'] = $query;
-
         null !== $confidenceThreshold && $self['confidenceThreshold'] = $confidenceThreshold;
 
         return $self;
     }
 
-    public function withQuery(string $query): self
-    {
-        $self = clone $this;
-        $self['query'] = $query;
-
-        return $self;
-    }
-
     /**
      * @param 'semantic' $type
      */

src/Monitors/MonitorCreateParams/Target/MonitorsExtractTarget.php

@@ -13,10 +13,10 @@
  * Watch a site's extracted structured data.
  *
  * @phpstan-type MonitorsExtractTargetShape = array{
+ *   instructions: string,
  *   type: 'extract',
  *   url: string,
  *   followSubdomains?: bool|null,
- *   instructions?: string|null,
  *   maxDepth?: int|null,
  *   maxPages?: int|null,
  *   schema?: array<string,mixed>|null,
@@ -31,6 +31,12 @@ final class MonitorsExtractTarget implements BaseModel
     #[Required]
     public string $type = 'extract';
 
+    /**
+     * Natural-language instructions describing what to extract and watch. This single prompt scopes both the extraction and what changes get reported: only data captured by the schema and these instructions is compared between runs.
+     */
+    #[Required]
+    public string $instructions;
+
     /**
      * Root URL to extract structured data from.
      */
@@ -40,12 +46,6 @@ final class MonitorsExtractTarget implements BaseModel
     #[Optional('follow_subdomains')]
     public ?bool $followSubdomains;
 
-    /**
-     * Optional natural-language instructions guiding what to extract.
-     */
-    #[Optional]
-    public ?string $instructions;
-
     /**
      * Optional maximum link depth from the starting URL (0 = only the starting page).
      */
@@ -71,13 +71,13 @@ final class MonitorsExtractTarget implements BaseModel
      *
      * To enforce required parameters use
      * ```
-     * MonitorsExtractTarget::with(url: ...)
+     * MonitorsExtractTarget::with(instructions: ..., url: ...)
      * ```
      *
      * Otherwise ensure the following setters are called
      *
      * ```
-     * (new MonitorsExtractTarget)->withURL(...)
+     * (new MonitorsExtractTarget)->withInstructions(...)->withURL(...)
      * ```
      */
     public function __construct()
@@ -93,26 +93,37 @@ public function __construct()
      * @param array<string,mixed>|null $schema
      */
     public static function with(
+        string $instructions,
         string $url,
         ?bool $followSubdomains = null,
-        ?string $instructions = null,
         ?int $maxDepth = null,
         ?int $maxPages = null,
         ?array $schema = null,
     ): self {
         $self = new self;
 
+        $self['instructions'] = $instructions;
         $self['url'] = $url;
 
         null !== $followSubdomains && $self['followSubdomains'] = $followSubdomains;
-        null !== $instructions && $self['instructions'] = $instructions;
         null !== $maxDepth && $self['maxDepth'] = $maxDepth;
         null !== $maxPages && $self['maxPages'] = $maxPages;
         null !== $schema && $self['schema'] = $schema;
 
         return $self;
     }
 
+    /**
+     * Natural-language instructions describing what to extract and watch. This single prompt scopes both the extraction and what changes get reported: only data captured by the schema and these instructions is compared between runs.
+     */
+    public function withInstructions(string $instructions): self
+    {
+        $self = clone $this;
+        $self['instructions'] = $instructions;
+
+        return $self;
+    }
+
     /**
      * @param 'extract' $type
      */
@@ -143,17 +154,6 @@ public function withFollowSubdomains(bool $followSubdomains): self
         return $self;
     }
 
-    /**
-     * Optional natural-language instructions guiding what to extract.
-     */
-    public function withInstructions(string $instructions): self
-    {
-        $self = clone $this;
-        $self['instructions'] = $instructions;
-
-        return $self;
-    }
-
     /**
      * Optional maximum link depth from the starting URL (0 = only the starting page).
      */

src/Monitors/MonitorGetChangeResponse.php

@@ -40,7 +40,6 @@
  *   importance?: null|Importance|value-of<Importance>,
  *   matchedURLCount?: int|null,
  *   matchedURLs?: list<string>|null,
- *   query?: string|null,
  *   removedURLCount?: int|null,
  *   removedURLs?: list<string>|null,
  *   tags?: list<string>|null,
@@ -136,9 +135,6 @@ final class MonitorGetChangeResponse implements BaseModel
     #[Optional('matched_urls', list: 'string')]
     public ?array $matchedURLs;
 
-    #[Optional]
-    public ?string $query;
-
     #[Optional('removed_url_count')]
     public ?int $removedURLCount;
 
@@ -234,7 +230,6 @@ public static function with(
         Importance|string|null $importance = null,
         ?int $matchedURLCount = null,
         ?array $matchedURLs = null,
-        ?string $query = null,
         ?int $removedURLCount = null,
         ?array $removedURLs = null,
         ?array $tags = null,
@@ -262,7 +257,6 @@ public static function with(
         null !== $importance && $self['importance'] = $importance;
         null !== $matchedURLCount && $self['matchedURLCount'] = $matchedURLCount;
         null !== $matchedURLs && $self['matchedURLs'] = $matchedURLs;
-        null !== $query && $self['query'] = $query;
         null !== $removedURLCount && $self['removedURLCount'] = $removedURLCount;
         null !== $removedURLs && $self['removedURLs'] = $removedURLs;
         null !== $tags && $self['tags'] = $tags;
@@ -464,14 +458,6 @@ public function withMatchedURLs(array $matchedURLs): self
         return $self;
     }
 
-    public function withQuery(string $query): self
-    {
-        $self = clone $this;
-        $self['query'] = $query;
-
-        return $self;
-    }
-
     public function withRemovedURLCount(int $removedURLCount): self
     {
         $self = clone $this;

src/Monitors/MonitorGetResponse/ChangeDetection/MonitorsSemanticChangeDetection.php

@@ -10,10 +10,10 @@
 use ContextDev\Core\Contracts\BaseModel;
 
 /**
- * Detect meaning-level changes that match a natural language query.
+ * Detect meaning-level changes to the extracted data, ignoring cosmetic or paraphrase-only differences. What is watched is determined by the extract target's `schema` and `instructions`.
  *
  * @phpstan-type MonitorsSemanticChangeDetectionShape = array{
- *   query: string, type: 'semantic', confidenceThreshold?: float|null
+ *   type: 'semantic', confidenceThreshold?: float|null
  * }
  */
 final class MonitorsSemanticChangeDetection implements BaseModel
@@ -25,26 +25,9 @@ final class MonitorsSemanticChangeDetection implements BaseModel
     #[Required]
     public string $type = 'semantic';
 
-    #[Required]
-    public string $query;
-
     #[Optional('confidence_threshold')]
     public ?float $confidenceThreshold;
 
-    /**
-     * `new MonitorsSemanticChangeDetection()` is missing required properties by the API.
-     *
-     * To enforce required parameters use
-     * ```
-     * MonitorsSemanticChangeDetection::with(query: ...)
-     * ```
-     *
-     * Otherwise ensure the following setters are called
-     *
-     * ```
-     * (new MonitorsSemanticChangeDetection)->withQuery(...)
-     * ```
-     */
     public function __construct()
     {
         $this->initialize();
@@ -55,27 +38,15 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      */
-    public static function with(
-        string $query,
-        ?float $confidenceThreshold = null
-    ): self {
+    public static function with(?float $confidenceThreshold = null): self
+    {
         $self = new self;
 
-        $self['query'] = $query;
-
         null !== $confidenceThreshold && $self['confidenceThreshold'] = $confidenceThreshold;
 
         return $self;
     }
 
-    public function withQuery(string $query): self
-    {
-        $self = clone $this;
-        $self['query'] = $query;
-
-        return $self;
-    }
-
     /**
      * @param 'semantic' $type
      */