docs(api): updates to API spec

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-d15316b8a3a086ae9ec8eea0d436b0885262df9bcf23b9587ad059e50357c220.yml
-openapi_spec_hash: 4f81a4f4840438f80eff345e76ead962
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-a8e20e751972f7b8c948a833764b02d0835b380189eaf7393d63eb2250dbd598.yml
+openapi_spec_hash: 6f27335468bc5bf01fbcd1454330fb07
 config_hash: ee2e5a914fd298a6f4c740f5ce187f87

src/resources/applications/applications.ts

@@ -26,16 +26,16 @@ export class Applications extends APIResource {
   graphs: GraphsAPI.Graphs = new GraphsAPI.Graphs(this._client);
 
   /**
-   * Retrieves detailed information for a specific no-code application, including its
-   * configuration and current status.
+   * Retrieves detailed information for a specific no-code agent (formerly called
+   * no-code applications), including its configuration and current status.
    */
   retrieve(applicationID: string, options?: RequestOptions): APIPromise<ApplicationRetrieveResponse> {
     return this._client.get(path`/v1/applications/${applicationID}`, options);
   }
 
   /**
-   * Retrieves a paginated list of no-code applications with optional filtering and
-   * sorting capabilities.
+   * Retrieves a paginated list of no-code agents (formerly called no-code
+   * applications) with optional filtering and sorting capabilities.
    */
   list(
     query: ApplicationListParams | null | undefined = {},
@@ -48,7 +48,8 @@ export class Applications extends APIResource {
   }
 
   /**
-   * Generate content from an existing no-code application with inputs.
+   * Generate content from an existing no-code agent (formerly called no-code
+   * applications) with inputs.
    */
   generateContent(
     applicationID: string,
@@ -479,10 +480,10 @@ export namespace ApplicationGenerateContentParams {
      *
      * If the input type is "File upload", you must pass the `file_id` of an uploaded
      * file. You cannot pass a file object directly. See the
-     * [file upload endpoint](/api-guides/api-reference/file-api/upload-files) for
-     * instructions on uploading files or the
-     * [list files endpoint](/api-guides/api-reference/file-api/get-all-files) for how
-     * to see a list of uploaded files and their IDs.
+     * [file upload endpoint](https://dev.writer.com/api-guides/api-reference/file-api/upload-files)
+     * for instructions on uploading files or the
+     * [list files endpoint](https://dev.writer.com/api-guides/api-reference/file-api/get-all-files)
+     * for how to see a list of uploaded files and their IDs.
      */
     value: Array<string>;
   }

src/resources/applications/graphs.ts

@@ -7,8 +7,7 @@ import { path } from '../../internal/utils/path';
 
 export class Graphs extends APIResource {
   /**
-   * Updates the Knowledge Graphs listed and associates them with the no-code chat
-   * app to be used.
+   * Updates the Knowledge Graphs listed and associates them with the no-code agent.
    */
   update(
     applicationID: string,
@@ -19,7 +18,8 @@ export class Graphs extends APIResource {
   }
 
   /**
-   * Retrieve Knowledge Graphs associated with a no-code chat application.
+   * Retrieve Knowledge Graphs associated with a no-code agent that has chat
+   * capabilities.
    */
   list(applicationID: string, options?: RequestOptions): APIPromise<ApplicationGraphsResponse> {
     return this._client.get(path`/v1/applications/${applicationID}/graphs`, options);

src/resources/applications/jobs.ts

@@ -9,7 +9,8 @@ import { path } from '../../internal/utils/path';
 
 export class Jobs extends APIResource {
   /**
-   * Generate content asynchronously from an existing application with inputs.
+   * Generate content asynchronously from an existing no-code agent (formerly called
+   * no-code applications) with inputs.
    */
   create(
     applicationID: string,
@@ -176,10 +177,10 @@ export namespace JobCreateParams {
      *
      * If the input type is "File upload", you must pass the `file_id` of an uploaded
      * file. You cannot pass a file object directly. See the
-     * [file upload endpoint](/api-guides/api-reference/file-api/upload-files) for
-     * instructions on uploading files or the
-     * [list files endpoint](/api-guides/api-reference/file-api/get-all-files) for how
-     * to see a list of uploaded files and their IDs.
+     * [file upload endpoint](https://dev.writer.com/api-guides/api-reference/file-api/upload-files)
+     * for instructions on uploading files or the
+     * [list files endpoint](https://dev.writer.com/api-guides/api-reference/file-api/get-all-files)
+     * for how to see a list of uploaded files and their IDs.
      */
     value: Array<string>;
   }

src/resources/chat.ts

@@ -14,7 +14,7 @@ export class Chat extends APIResource {
   /**
    * Generate a chat completion based on the provided messages. The response shown
    * below is for non-streaming. To learn about streaming responses, see the
-   * [chat completion guide](/api-guides/chat-completion).
+   * [chat completion guide](https://dev.writer.com/api-guides/chat-completion).
    */
   chat(body: ChatChatParamsNonStreaming, options?: RequestOptions): APIPromise<ChatCompletion>;
   chat(body: ChatChatParamsStreaming, options?: RequestOptions): APIPromise<Stream<ChatCompletionChunk>>;
@@ -282,10 +282,10 @@ export interface ChatCompletionParams {
   messages: Array<ChatCompletionParams.Message>;
 
   /**
-   * Specifies the model to be used for generating responses. The chat model is
-   * always `palmyra-x-004` for conversational use.
+   * The [ID of the model](https://dev.writer.com/home/models) to use for creating
+   * the chat completion.
    */
-  model: string;
+  model: 'palmyra-x-004' | 'palmyra-fin' | 'palmyra-med' | 'palmyra-creative' | 'palmyra-x-003-instruct';
 
   /**
    * Specifies whether to return log probabilities of the output tokens.
@@ -301,7 +301,7 @@ export interface ChatCompletionParams {
 
   /**
    * Specifies the number of completions (responses) to generate from the model in a
-   * single request. This parameter allows multiple responses to be generated,
+   * single request. This parameter allows for generating multiple responses,
    * offering a variety of potential replies from which to choose.
    */
   n?: number;
@@ -344,7 +344,9 @@ export interface ChatCompletionParams {
    * generate responses. The tool definitions use JSON schema. You can define your
    * own functions or use one of the built-in `graph`, `llm`, or `vision` tools. Note
    * that you can only use one built-in tool type in the array (only one of `graph`,
-   * `llm`, or `vision`).
+   * `llm`, or `vision`). You can pass multiple custom
+   * tools](https://dev.writer.com/api-guides/tool-calling) of type `function` in the
+   * same request.
    */
   tools?: Array<Shared.ToolParam>;
 
@@ -362,7 +364,8 @@ export namespace ChatCompletionParams {
     /**
      * The role of the chat message. You can provide a system prompt by setting the
      * role to `system`, or specify that a message is the result of a
-     * [tool call](/api-guides/tool-calling) by setting the role to `tool`.
+     * [tool call](https://dev.writer.com/api-guides/tool-calling) by setting the role
+     * to `tool`.
      */
     role: 'user' | 'assistant' | 'system' | 'tool';
 
@@ -426,10 +429,10 @@ export interface ChatChatParamsBase {
   messages: Array<ChatChatParams.Message>;
 
   /**
-   * Specifies the model to be used for generating responses. The chat model is
-   * always `palmyra-x-004` for conversational use.
+   * The [ID of the model](https://dev.writer.com/home/models) to use for creating
+   * the chat completion.
    */
-  model: string;
+  model: 'palmyra-x-004' | 'palmyra-fin' | 'palmyra-med' | 'palmyra-creative' | 'palmyra-x-003-instruct';
 
   /**
    * Specifies whether to return log probabilities of the output tokens.
@@ -445,7 +448,7 @@ export interface ChatChatParamsBase {
 
   /**
    * Specifies the number of completions (responses) to generate from the model in a
-   * single request. This parameter allows multiple responses to be generated,
+   * single request. This parameter allows for generating multiple responses,
    * offering a variety of potential replies from which to choose.
    */
   n?: number;
@@ -488,7 +491,9 @@ export interface ChatChatParamsBase {
    * generate responses. The tool definitions use JSON schema. You can define your
    * own functions or use one of the built-in `graph`, `llm`, or `vision` tools. Note
    * that you can only use one built-in tool type in the array (only one of `graph`,
-   * `llm`, or `vision`).
+   * `llm`, or `vision`). You can pass multiple custom
+   * tools](https://dev.writer.com/api-guides/tool-calling) of type `function` in the
+   * same request.
    */
   tools?: Array<Shared.ToolParam>;
 
@@ -506,7 +511,8 @@ export namespace ChatChatParams {
     /**
      * The role of the chat message. You can provide a system prompt by setting the
      * role to `system`, or specify that a message is the result of a
-     * [tool call](/api-guides/tool-calling) by setting the role to `tool`.
+     * [tool call](https://dev.writer.com/api-guides/tool-calling) by setting the role
+     * to `tool`.
      */
     role: 'user' | 'assistant' | 'system' | 'tool';
 

src/resources/completions.ts

@@ -62,9 +62,10 @@ export interface CompletionChunk {
 
 export interface CompletionParams {
   /**
-   * The identifier of the model to be used for processing the request.
+   * The [ID of the model](https://dev.writer.com/home/models) to use for generating
+   * text.
    */
-  model: string;
+  model: 'palmyra-x-004' | 'palmyra-fin' | 'palmyra-med' | 'palmyra-creative' | 'palmyra-x-003-instruct';
 
   /**
    * The input text that the model will process to generate a response.
@@ -120,9 +121,10 @@ export type CompletionCreateParams = CompletionCreateParamsNonStreaming | Comple
 
 export interface CompletionCreateParamsBase {
   /**
-   * The identifier of the model to be used for processing the request.
+   * The [ID of the model](https://dev.writer.com/home/models) to use for generating
+   * text.
    */
-  model: string;
+  model: 'palmyra-x-004' | 'palmyra-fin' | 'palmyra-med' | 'palmyra-creative' | 'palmyra-x-003-instruct';
 
   /**
    * The input text that the model will process to generate a response.

src/resources/files.ts

@@ -143,7 +143,7 @@ export interface FileListParams extends CursorPageParams {
 
 export interface FileRetryParams {
   /**
-   * The unique identifier of the files to be retried.
+   * The unique identifier of the files to retry.
    */
   file_ids: Array<string>;
 }

src/resources/graphs.ts

@@ -311,12 +311,12 @@ export type GraphQuestionParams = GraphQuestionParamsNonStreaming | GraphQuestio
 
 export interface GraphQuestionParamsBase {
   /**
-   * The unique identifiers of the Knowledge Graphs to be queried.
+   * The unique identifiers of the Knowledge Graphs to query.
    */
   graph_ids: Array<string>;
 
   /**
-   * The question to be answered using the Knowledge Graph.
+   * The question to answer using the Knowledge Graph.
    */
   question: string;
 

src/resources/models.ts

@@ -15,7 +15,8 @@ export class Models extends APIResource {
 
 export interface ModelListResponse {
   /**
-   * The identifier of the model to be used for processing the request.
+   * The [ID of the model](https://dev.writer.com/home/models) to use for processing
+   * the request.
    */
   models: Array<ModelListResponse.Model>;
 }

src/resources/shared.ts

@@ -188,7 +188,7 @@ export namespace ToolParam {
      */
     export interface Function {
       /**
-       * An array of graph IDs to be used in the tool.
+       * An array of graph IDs to use in the tool.
        */
       graph_ids: Array<string>;
 
@@ -222,12 +222,12 @@ export namespace ToolParam {
      */
     export interface Function {
       /**
-       * A description of the model to be used.
+       * A description of the model to use.
        */
       description: string;
 
       /**
-       * The model to be used.
+       * The model to use.
        */
       model: string;
     }
@@ -251,17 +251,17 @@ export namespace ToolParam {
      */
     export interface Function {
       /**
-       * The model to be used for image analysis. Must be `palmyra-vision`.
+       * The model to use for image analysis.
        */
-      model: string;
+      model: 'palmyra-vision';
 
       variables: Array<Function.Variable>;
     }
 
     export namespace Function {
       export interface Variable {
         /**
-         * The File ID of the image to be analyzed. The file must be uploaded to the Writer
+         * The File ID of the image to analyze. The file must be uploaded to the Writer
          * platform before you use it with the Vision tool.
          */
         file_id: string;