feat(api): add translation endpoint

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 30
+configured_endpoints: 31
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-a8e20e751972f7b8c948a833764b02d0835b380189eaf7393d63eb2250dbd598.yml
 openapi_spec_hash: 6f27335468bc5bf01fbcd1454330fb07
-config_hash: ee2e5a914fd298a6f4c740f5ce187f87
+config_hash: 1f6d0bf7309d0007e28ab85b89a0de85

api.md

@@ -157,6 +157,17 @@ Methods:
 
 - <code title="post /v1/tools/comprehend/medical">client.tools.comprehend.<a href="./src/resources/tools/comprehend.ts">medical</a>({ ...params }) -> ComprehendMedicalResponse</code>
 
+# Translation
+
+Types:
+
+- <code><a href="./src/resources/translation.ts">TranslationRequest</a></code>
+- <code><a href="./src/resources/translation.ts">TranslationResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/translation">client.translation.<a href="./src/resources/translation.ts">translate</a>({ ...params }) -> TranslationResponse</code>
+
 # Vision
 
 Types:

src/client.ts

@@ -79,6 +79,12 @@ import {
   QuestionResponseChunk,
 } from './resources/graphs';
 import { ModelListResponse, Models } from './resources/models';
+import {
+  Translation,
+  TranslationRequest,
+  TranslationResponse,
+  TranslationTranslateParams,
+} from './resources/translation';
 import { Vision, VisionAnalyzeParams, VisionRequest, VisionResponse } from './resources/vision';
 import { readEnv } from './internal/utils/env';
 import { formatRequestDetails, loggerFor } from './internal/utils/log';
@@ -778,6 +784,7 @@ export class Writer {
   graphs: API.Graphs = new API.Graphs(this);
   files: API.Files = new API.Files(this);
   tools: API.Tools = new API.Tools(this);
+  translation: API.Translation = new API.Translation(this);
   vision: API.Vision = new API.Vision(this);
 }
 Writer.Applications = Applications;
@@ -787,6 +794,7 @@ Writer.Models = Models;
 Writer.Graphs = Graphs;
 Writer.Files = Files;
 Writer.Tools = Tools;
+Writer.Translation = Translation;
 Writer.Vision = Vision;
 export declare namespace Writer {
   export type RequestOptions = Opts.RequestOptions;
@@ -877,6 +885,13 @@ export declare namespace Writer {
     type ToolParsePdfParams as ToolParsePdfParams,
   };
 
+  export {
+    Translation as Translation,
+    type TranslationRequest as TranslationRequest,
+    type TranslationResponse as TranslationResponse,
+    type TranslationTranslateParams as TranslationTranslateParams,
+  };
+
   export {
     Vision as Vision,
     type VisionRequest as VisionRequest,

src/resources/index.ts

@@ -71,4 +71,10 @@ export {
   type ToolContextAwareSplittingParams,
   type ToolParsePdfParams,
 } from './tools/tools';
+export {
+  Translation,
+  type TranslationRequest,
+  type TranslationResponse,
+  type TranslationTranslateParams,
+} from './translation';
 export { Vision, type VisionRequest, type VisionResponse, type VisionAnalyzeParams } from './vision';

src/resources/translation.ts

@@ -0,0 +1,139 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Translation extends APIResource {
+  /**
+   * Translate text from one language to another.
+   */
+  translate(body: TranslationTranslateParams, options?: RequestOptions): APIPromise<TranslationResponse> {
+    return this._client.post('/v1/translation', { body, ...options });
+  }
+}
+
+export interface TranslationRequest {
+  /**
+   * Whether to use formal or informal language in the translation. See the
+   * [list of languages that support formality](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#formality).
+   * If the language does not support formality, this parameter is ignored.
+   */
+  formality: boolean;
+
+  /**
+   * Whether to control the length of the translated text. See the
+   * [list of languages that support length control](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#length-control).
+   * If the language does not support length control, this parameter is ignored.
+   */
+  length_control: boolean;
+
+  /**
+   * Whether to mask profane words in the translated text. See the
+   * [list of languages that do not support profanity masking](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#profanity-masking).
+   * If the language does not support profanity masking, this parameter is ignored.
+   */
+  mask_profanity: boolean;
+
+  /**
+   * The model to use for translation.
+   */
+  model: 'palmyra-translate';
+
+  /**
+   * The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
+   * language code of the original text to translate. For example, `en` for English,
+   * `zh` for Chinese, `fr` for French, `es` for Spanish. If the language has a
+   * variant, the code appends the two-digit
+   * [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
+   * For example, Mexican Spanish is `es-MX`. See the
+   * [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+   */
+  source_language_code: string;
+
+  /**
+   * The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
+   * language code of the target language for the translation. For example, `en` for
+   * English, `zh` for Chinese, `fr` for French, `es` for Spanish. If the language
+   * has a variant, the code appends the two-digit
+   * [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
+   * For example, Mexican Spanish is `es-MX`. See the
+   * [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+   */
+  target_language_code: string;
+
+  /**
+   * The text to translate. Maximum of 100,000 words.
+   */
+  text: string;
+}
+
+export interface TranslationResponse {
+  /**
+   * The result of the translation.
+   */
+  data: string;
+}
+
+export interface TranslationTranslateParams {
+  /**
+   * Whether to use formal or informal language in the translation. See the
+   * [list of languages that support formality](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#formality).
+   * If the language does not support formality, this parameter is ignored.
+   */
+  formality: boolean;
+
+  /**
+   * Whether to control the length of the translated text. See the
+   * [list of languages that support length control](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#length-control).
+   * If the language does not support length control, this parameter is ignored.
+   */
+  length_control: boolean;
+
+  /**
+   * Whether to mask profane words in the translated text. See the
+   * [list of languages that do not support profanity masking](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#profanity-masking).
+   * If the language does not support profanity masking, this parameter is ignored.
+   */
+  mask_profanity: boolean;
+
+  /**
+   * The model to use for translation.
+   */
+  model: 'palmyra-translate';
+
+  /**
+   * The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
+   * language code of the original text to translate. For example, `en` for English,
+   * `zh` for Chinese, `fr` for French, `es` for Spanish. If the language has a
+   * variant, the code appends the two-digit
+   * [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
+   * For example, Mexican Spanish is `es-MX`. See the
+   * [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+   */
+  source_language_code: string;
+
+  /**
+   * The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
+   * language code of the target language for the translation. For example, `en` for
+   * English, `zh` for Chinese, `fr` for French, `es` for Spanish. If the language
+   * has a variant, the code appends the two-digit
+   * [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
+   * For example, Mexican Spanish is `es-MX`. See the
+   * [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+   */
+  target_language_code: string;
+
+  /**
+   * The text to translate. Maximum of 100,000 words.
+   */
+  text: string;
+}
+
+export declare namespace Translation {
+  export {
+    type TranslationRequest as TranslationRequest,
+    type TranslationResponse as TranslationResponse,
+    type TranslationTranslateParams as TranslationTranslateParams,
+  };
+}

tests/api-resources/translation.test.ts

@@ -0,0 +1,41 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import Writer from 'writer-sdk';
+
+const client = new Writer({
+  apiKey: 'My API Key',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource translation', () => {
+  test('translate: only required params', async () => {
+    const responsePromise = client.translation.translate({
+      formality: true,
+      length_control: true,
+      mask_profanity: true,
+      model: 'palmyra-translate',
+      source_language_code: 'en',
+      target_language_code: 'es',
+      text: 'Hello, world!',
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('translate: required and optional params', async () => {
+    const response = await client.translation.translate({
+      formality: true,
+      length_control: true,
+      mask_profanity: true,
+      model: 'palmyra-translate',
+      source_language_code: 'en',
+      target_language_code: 'es',
+      text: 'Hello, world!',
+    });
+  });
+});