Fixing descriptions in the Inference APIs (#5549) (#5565)

(cherry picked from commit 8dd0bca)

Co-authored-by: kosabogi <105062005+kosabogi@users.noreply.github.com>

Author: github-actions[bot]

specification/inference/_types/CommonTypes.ts

@@ -30,7 +30,7 @@ export class RequestChatCompletion {
    */
   messages: Array<Message>
   /**
-   * The ID of the model to use.
+   * The ID of the model to use. By default, the model ID is set to the value included when creating the inference endpoint.
    */
   model?: string
   /**

specification/inference/completion/CompletionRequest.ts

@@ -56,7 +56,7 @@ export interface Request extends RequestBase {
      */
     input: string | Array<string>
     /**
-     * Optional task settings
+     * Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.
      */
     task_settings?: TaskSettings
   }

specification/inference/delete/DeleteRequest.ts

@@ -53,7 +53,7 @@ export interface Request extends RequestBase {
   }
   query_parameters: {
     /**
-     * When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.
+     * When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.
      * @server_default false
      */
     dry_run?: boolean

specification/inference/put_anthropic/PutAnthropicRequest.ts

@@ -68,7 +68,7 @@ export interface Request extends RequestBase {
      */
     service: AnthropicServiceType
     /**
-     * Settings used to install the inference model. These settings are specific to the `watsonxai` service.
+     * Settings used to install the inference model. These settings are specific to the `anthropic` service.
      */
     service_settings: AnthropicServiceSettings
     /**

specification/inference/put_azureaistudio/PutAzureAiStudioRequest.ts

@@ -75,7 +75,7 @@ export interface Request extends RequestBase {
      */
     service: AzureAiStudioServiceType
     /**
-     * Settings used to install the inference model. These settings are specific to the `openai` service.
+     * Settings used to install the inference model. These settings are specific to the `azureaistudio` service.
      */
     service_settings: AzureAiStudioServiceSettings
     /**

specification/inference/sparse_embedding/SparseEmbeddingRequest.ts

@@ -56,7 +56,7 @@ export interface Request extends RequestBase {
      */
     input: string | Array<string>
     /**
-     * Optional task settings
+     * Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.
      */
     task_settings?: TaskSettings
   }

specification/inference/stream_completion/StreamInferenceRequest.ts

@@ -64,7 +64,7 @@ export interface Request extends RequestBase {
      */
     input: string | string[]
     /**
-     * Optional task settings
+     * Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.
      */
     task_settings?: TaskSettings
   }

specification/inference/text_embedding/TextEmbeddingRequest.ts

@@ -69,7 +69,7 @@ export interface Request extends RequestBase {
      */
     input_type?: string
     /**
-     * Optional task settings
+     * Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.
      */
     task_settings?: TaskSettings
   }