feat(api): Deprecate AI Detection, Medical Comprehend, and Context-Aware Text Splitting

Remove AI Detection, Medical Comprehend, text to graph, and Context-Aware Text Splitting from SDKs.

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 30
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-ea6b4de3976794a02ea8fc01669d901cd7b159ba0d598cc9653e01c987a2f806.yml
 openapi_spec_hash: 4d4a9ba232d19a6180e6d4a7d5566103
-config_hash: 247c2ce23a36ef7446d356308329c87b
+config_hash: 8701b1a467238f1afdeceeb7feb1adc6

api.md

@@ -139,15 +139,13 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/tools/tools.ts">ToolParsePdfResponse</a></code>
-- <code><a href="./src/resources/tools/tools.ts">ToolWebSearchResponse</a></code>
+- <code><a href="./src/resources/tools.ts">ToolParsePdfResponse</a></code>
+- <code><a href="./src/resources/tools.ts">ToolWebSearchResponse</a></code>
 
 Methods:
 
-- <code title="post /v1/tools/pdf-parser/{file_id}">client.tools.<a href="./src/resources/tools/tools.ts">parsePdf</a>(fileID, { ...params }) -> ToolParsePdfResponse</code>
-- <code title="post /v1/tools/web-search">client.tools.<a href="./src/resources/tools/tools.ts">webSearch</a>({ ...params }) -> ToolWebSearchResponse</code>
-
-## Comprehend
+- <code title="post /v1/tools/pdf-parser/{file_id}">client.tools.<a href="./src/resources/tools.ts">parsePdf</a>(fileID, { ...params }) -> ToolParsePdfResponse</code>
+- <code title="post /v1/tools/web-search">client.tools.<a href="./src/resources/tools.ts">webSearch</a>({ ...params }) -> ToolWebSearchResponse</code>
 
 # Translation
 

src/client.ts

@@ -76,6 +76,13 @@ import {
   QuestionResponseChunk,
 } from './resources/graphs';
 import { ModelListResponse, Models } from './resources/models';
+import {
+  ToolParsePdfParams,
+  ToolParsePdfResponse,
+  ToolWebSearchParams,
+  ToolWebSearchResponse,
+  Tools,
+} from './resources/tools';
 import {
   Translation,
   TranslationRequest,
@@ -95,13 +102,6 @@ import {
   ApplicationRetrieveResponse,
   Applications,
 } from './resources/applications/applications';
-import {
-  ToolParsePdfParams,
-  ToolParsePdfResponse,
-  ToolWebSearchParams,
-  ToolWebSearchResponse,
-  Tools,
-} from './resources/tools/tools';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';

src/resources/index.ts

@@ -70,7 +70,7 @@ export {
   type ToolWebSearchResponse,
   type ToolParsePdfParams,
   type ToolWebSearchParams,
-} from './tools/tools';
+} from './tools';
 export {
   Translation,
   type TranslationRequest,

src/resources/tools.ts

@@ -1,3 +1,335 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './tools/index';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Tools extends APIResource {
+  /**
+   * Parse PDF to other formats.
+   *
+   * @deprecated Will be removed in a future release. A replacement PDF parsing tool for chat completions is planned; see documentation at dev.writer.com for more information.
+   */
+  parsePdf(
+    fileID: string,
+    body: ToolParsePdfParams,
+    options?: RequestOptions,
+  ): APIPromise<ToolParsePdfResponse> {
+    return this._client.post(path`/v1/tools/pdf-parser/${fileID}`, { body, ...options });
+  }
+
+  /**
+   * Search the web for information about a given query and return relevant results
+   * with source URLs.
+   *
+   * @deprecated Will be removed in a future release. Migrate to `chat.chat` with the web search tool for web search capabilities. See documentation at dev.writer.com for more information.
+   */
+  webSearch(body: ToolWebSearchParams, options?: RequestOptions): APIPromise<ToolWebSearchResponse> {
+    return this._client.post('/v1/tools/web-search', { body, ...options });
+  }
+}
+
+export interface ToolParsePdfResponse {
+  /**
+   * The extracted content from the PDF file, converted to the specified format.
+   */
+  content: string;
+}
+
+export interface ToolWebSearchResponse {
+  /**
+   * The search query that was submitted.
+   */
+  query: string;
+
+  /**
+   * The search results found.
+   */
+  sources: Array<ToolWebSearchResponse.Source>;
+
+  /**
+   * Generated answer based on the search results. Not included if `include_answer`
+   * is `false`.
+   */
+  answer?: string;
+}
+
+export namespace ToolWebSearchResponse {
+  export interface Source {
+    /**
+     * Raw content from the source URL. Not included if `include_raw_content` is
+     * `false`.
+     */
+    raw_content?: string;
+
+    /**
+     * URL of the search result.
+     */
+    url?: string;
+  }
+}
+
+export interface ToolParsePdfParams {
+  /**
+   * The format into which the PDF content should be converted.
+   */
+  format: 'text' | 'markdown';
+}
+
+export interface ToolWebSearchParams {
+  /**
+   * Only applies when `search_depth` is `advanced`. Specifies how many text segments
+   * to extract from each source. Limited to 3 chunks maximum.
+   */
+  chunks_per_source?: number;
+
+  /**
+   * Localizes search results to a specific country. Only applies to general topic
+   * searches.
+   */
+  country?:
+    | 'afghanistan'
+    | 'albania'
+    | 'algeria'
+    | 'andorra'
+    | 'angola'
+    | 'argentina'
+    | 'armenia'
+    | 'australia'
+    | 'austria'
+    | 'azerbaijan'
+    | 'bahamas'
+    | 'bahrain'
+    | 'bangladesh'
+    | 'barbados'
+    | 'belarus'
+    | 'belgium'
+    | 'belize'
+    | 'benin'
+    | 'bhutan'
+    | 'bolivia'
+    | 'bosnia and herzegovina'
+    | 'botswana'
+    | 'brazil'
+    | 'brunei'
+    | 'bulgaria'
+    | 'burkina faso'
+    | 'burundi'
+    | 'cambodia'
+    | 'cameroon'
+    | 'canada'
+    | 'cape verde'
+    | 'central african republic'
+    | 'chad'
+    | 'chile'
+    | 'china'
+    | 'colombia'
+    | 'comoros'
+    | 'congo'
+    | 'costa rica'
+    | 'croatia'
+    | 'cuba'
+    | 'cyprus'
+    | 'czech republic'
+    | 'denmark'
+    | 'djibouti'
+    | 'dominican republic'
+    | 'ecuador'
+    | 'egypt'
+    | 'el salvador'
+    | 'equatorial guinea'
+    | 'eritrea'
+    | 'estonia'
+    | 'ethiopia'
+    | 'fiji'
+    | 'finland'
+    | 'france'
+    | 'gabon'
+    | 'gambia'
+    | 'georgia'
+    | 'germany'
+    | 'ghana'
+    | 'greece'
+    | 'guatemala'
+    | 'guinea'
+    | 'haiti'
+    | 'honduras'
+    | 'hungary'
+    | 'iceland'
+    | 'india'
+    | 'indonesia'
+    | 'iran'
+    | 'iraq'
+    | 'ireland'
+    | 'israel'
+    | 'italy'
+    | 'jamaica'
+    | 'japan'
+    | 'jordan'
+    | 'kazakhstan'
+    | 'kenya'
+    | 'kuwait'
+    | 'kyrgyzstan'
+    | 'latvia'
+    | 'lebanon'
+    | 'lesotho'
+    | 'liberia'
+    | 'libya'
+    | 'liechtenstein'
+    | 'lithuania'
+    | 'luxembourg'
+    | 'madagascar'
+    | 'malawi'
+    | 'malaysia'
+    | 'maldives'
+    | 'mali'
+    | 'malta'
+    | 'mauritania'
+    | 'mauritius'
+    | 'mexico'
+    | 'moldova'
+    | 'monaco'
+    | 'mongolia'
+    | 'montenegro'
+    | 'morocco'
+    | 'mozambique'
+    | 'myanmar'
+    | 'namibia'
+    | 'nepal'
+    | 'netherlands'
+    | 'new zealand'
+    | 'nicaragua'
+    | 'niger'
+    | 'nigeria'
+    | 'north korea'
+    | 'north macedonia'
+    | 'norway'
+    | 'oman'
+    | 'pakistan'
+    | 'panama'
+    | 'papua new guinea'
+    | 'paraguay'
+    | 'peru'
+    | 'philippines'
+    | 'poland'
+    | 'portugal'
+    | 'qatar'
+    | 'romania'
+    | 'russia'
+    | 'rwanda'
+    | 'saudi arabia'
+    | 'senegal'
+    | 'serbia'
+    | 'singapore'
+    | 'slovakia'
+    | 'slovenia'
+    | 'somalia'
+    | 'south africa'
+    | 'south korea'
+    | 'south sudan'
+    | 'spain'
+    | 'sri lanka'
+    | 'sudan'
+    | 'sweden'
+    | 'switzerland'
+    | 'syria'
+    | 'taiwan'
+    | 'tajikistan'
+    | 'tanzania'
+    | 'thailand'
+    | 'togo'
+    | 'trinidad and tobago'
+    | 'tunisia'
+    | 'turkey'
+    | 'turkmenistan'
+    | 'uganda'
+    | 'ukraine'
+    | 'united arab emirates'
+    | 'united kingdom'
+    | 'united states'
+    | 'uruguay'
+    | 'uzbekistan'
+    | 'venezuela'
+    | 'vietnam'
+    | 'yemen'
+    | 'zambia'
+    | 'zimbabwe';
+
+  /**
+   * For news topic searches, specifies how many days of news coverage to include.
+   */
+  days?: number;
+
+  /**
+   * Domains to exclude from the search. If unset, the search includes all domains.
+   */
+  exclude_domains?: Array<string>;
+
+  /**
+   * Whether to include a generated answer to the query in the response. If `false`,
+   * only search results are returned.
+   */
+  include_answer?: boolean;
+
+  /**
+   * Domains to include in the search. If unset, the search includes all domains.
+   */
+  include_domains?: Array<string>;
+
+  /**
+   * Controls how raw content is included in search results:
+   *
+   * - `text`: Returns plain text without formatting markup
+   * - `markdown`: Returns structured content with markdown formatting (headers,
+   *   links, bold text)
+   * - `true`: Same as `markdown`
+   * - `false`: Raw content is not included (default if unset)
+   */
+  include_raw_content?: 'text' | 'markdown' | boolean;
+
+  /**
+   * Limits the number of search results returned. Cannot exceed 20 sources.
+   */
+  max_results?: number;
+
+  /**
+   * The search query.
+   */
+  query?: string;
+
+  /**
+   * Controls search comprehensiveness:
+   *
+   * - `basic`: Returns fewer but highly relevant results
+   * - `advanced`: Performs a deeper search with more results
+   */
+  search_depth?: 'basic' | 'advanced';
+
+  /**
+   * Enables streaming of search results as they become available.
+   */
+  stream?: boolean;
+
+  /**
+   * Filters results to content published within the specified time range back from
+   * the current date. For example, `week` or `w` returns results from the past 7
+   * days.
+   */
+  time_range?: 'day' | 'week' | 'month' | 'year' | 'd' | 'w' | 'm' | 'y';
+
+  /**
+   * The search topic category. Use `news` for current events and news articles, or
+   * `general` for broader web search.
+   */
+  topic?: 'general' | 'news';
+}
+
+export declare namespace Tools {
+  export {
+    type ToolParsePdfResponse as ToolParsePdfResponse,
+    type ToolWebSearchResponse as ToolWebSearchResponse,
+    type ToolParsePdfParams as ToolParsePdfParams,
+    type ToolWebSearchParams as ToolWebSearchParams,
+  };
+}