From 4688ef4b36e9f383a3abf6cdb31d498163a7bb9e Mon Sep 17 00:00:00 2001
From: Stainless Bot <107565488+stainless-bot@users.noreply.github.com>
Date: Thu, 7 Mar 2024 19:13:22 +0100
Subject: [PATCH] docs: use @deprecated decorator for deprecated params (#711)

---
 src/resources/chat/completions.ts | 30 ++++++++++++++++++------------
 src/resources/files.ts            |  8 ++++----
 2 files changed, 22 insertions(+), 16 deletions(-)

diff --git a/src/resources/chat/completions.ts b/src/resources/chat/completions.ts
index 44627eb85..c2d6da0be 100644
--- a/src/resources/chat/completions.ts
+++ b/src/resources/chat/completions.ts
@@ -133,8 +133,8 @@ export interface ChatCompletionAssistantMessageParam {
   content?: string | null;
 
   /**
-   * Deprecated and replaced by `tool_calls`. The name and arguments of a function
-   * that should be called, as generated by the model.
+   * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
+   * a function that should be called, as generated by the model.
    */
   function_call?: ChatCompletionAssistantMessageParam.FunctionCall;
 
@@ -152,8 +152,8 @@ export interface ChatCompletionAssistantMessageParam {
 
 export namespace ChatCompletionAssistantMessageParam {
   /**
-   * Deprecated and replaced by `tool_calls`. The name and arguments of a function
-   * that should be called, as generated by the model.
+   * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
+   * a function that should be called, as generated by the model.
    */
   export interface FunctionCall {
     /**
@@ -250,8 +250,8 @@ export namespace ChatCompletionChunk {
       content?: string | null;
 
       /**
-       * Deprecated and replaced by `tool_calls`. The name and arguments of a function
-       * that should be called, as generated by the model.
+       * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
+       * a function that should be called, as generated by the model.
        */
       function_call?: Delta.FunctionCall;
 
@@ -265,8 +265,8 @@ export namespace ChatCompletionChunk {
 
     export namespace Delta {
       /**
-       * Deprecated and replaced by `tool_calls`. The name and arguments of a function
-       * that should be called, as generated by the model.
+       * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
+       * a function that should be called, as generated by the model.
        */
       export interface FunctionCall {
         /**
@@ -378,6 +378,9 @@ export interface ChatCompletionFunctionCallOption {
   name: string;
 }
 
+/**
+ * @deprecated
+ */
 export interface ChatCompletionFunctionMessageParam {
   /**
    * The contents of the function message.
@@ -410,8 +413,8 @@ export interface ChatCompletionMessage {
   role: 'assistant';
 
   /**
-   * Deprecated and replaced by `tool_calls`. The name and arguments of a function
-   * that should be called, as generated by the model.
+   * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
+   * a function that should be called, as generated by the model.
    */
   function_call?: ChatCompletionMessage.FunctionCall;
 
@@ -423,8 +426,8 @@ export interface ChatCompletionMessage {
 
 export namespace ChatCompletionMessage {
   /**
-   * Deprecated and replaced by `tool_calls`. The name and arguments of a function
-   * that should be called, as generated by the model.
+   * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
+   * a function that should be called, as generated by the model.
    */
   export interface FunctionCall {
     /**
@@ -855,6 +858,9 @@ export interface ChatCompletionCreateParamsBase {
 }
 
 export namespace ChatCompletionCreateParams {
+  /**
+   * @deprecated
+   */
   export interface Function {
     /**
      * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
diff --git a/src/resources/files.ts b/src/resources/files.ts
index db8f3a66a..cda487a63 100644
--- a/src/resources/files.ts
+++ b/src/resources/files.ts
@@ -154,14 +154,14 @@ export interface FileObject {
   purpose: 'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output';
 
   /**
-   * Deprecated. The current status of the file, which can be either `uploaded`,
-   * `processed`, or `error`.
+   * @deprecated: Deprecated. The current status of the file, which can be either
+   * `uploaded`, `processed`, or `error`.
    */
   status: 'uploaded' | 'processed' | 'error';
 
   /**
-   * Deprecated. For details on why a fine-tuning training file failed validation,
-   * see the `error` field on `fine_tuning.job`.
+   * @deprecated: Deprecated. For details on why a fine-tuning training file failed
+   * validation, see the `error` field on `fine_tuning.job`.
    */
   status_details?: string;
 }