From 7790ac2c6377b5daa53c53b8566f112ba09831ed Mon Sep 17 00:00:00 2001 From: kosabogi <105062005+kosabogi@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:01:27 +0100 Subject: [PATCH] Fixing descriptions in the Inference APIs (#5549) (cherry picked from commit 8dd0bcacafa552fb665e5c191bde7b24fd5eecc4) --- specification/inference/_types/CommonTypes.ts | 2 +- specification/inference/completion/CompletionRequest.ts | 2 +- specification/inference/delete/DeleteRequest.ts | 2 +- specification/inference/put_anthropic/PutAnthropicRequest.ts | 2 +- .../inference/put_azureaistudio/PutAzureAiStudioRequest.ts | 2 +- .../inference/sparse_embedding/SparseEmbeddingRequest.ts | 2 +- .../inference/stream_completion/StreamInferenceRequest.ts | 2 +- specification/inference/text_embedding/TextEmbeddingRequest.ts | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/inference/_types/CommonTypes.ts b/specification/inference/_types/CommonTypes.ts index 10f45fd4d7..130fc3fab6 100644 --- a/specification/inference/_types/CommonTypes.ts +++ b/specification/inference/_types/CommonTypes.ts @@ -30,7 +30,7 @@ export class RequestChatCompletion { */ messages: Array /** - * 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 /** diff --git a/specification/inference/completion/CompletionRequest.ts b/specification/inference/completion/CompletionRequest.ts index 2b05f213e1..1629556149 100644 --- a/specification/inference/completion/CompletionRequest.ts +++ b/specification/inference/completion/CompletionRequest.ts @@ -56,7 +56,7 @@ export interface Request extends RequestBase { */ input: string | Array /** - * Optional task settings + * Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service. */ task_settings?: TaskSettings } diff --git a/specification/inference/delete/DeleteRequest.ts b/specification/inference/delete/DeleteRequest.ts index c12bcbd16c..16cb1f0ddc 100644 --- a/specification/inference/delete/DeleteRequest.ts +++ b/specification/inference/delete/DeleteRequest.ts @@ -52,7 +52,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 diff --git a/specification/inference/put_anthropic/PutAnthropicRequest.ts b/specification/inference/put_anthropic/PutAnthropicRequest.ts index d7942495c3..ec0c4f5403 100644 --- a/specification/inference/put_anthropic/PutAnthropicRequest.ts +++ b/specification/inference/put_anthropic/PutAnthropicRequest.ts @@ -74,7 +74,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 /** diff --git a/specification/inference/put_azureaistudio/PutAzureAiStudioRequest.ts b/specification/inference/put_azureaistudio/PutAzureAiStudioRequest.ts index 6ab0d8b029..5313142e27 100644 --- a/specification/inference/put_azureaistudio/PutAzureAiStudioRequest.ts +++ b/specification/inference/put_azureaistudio/PutAzureAiStudioRequest.ts @@ -73,7 +73,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 /** diff --git a/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts b/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts index a9cc760b5a..7efe91dd82 100644 --- a/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts +++ b/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts @@ -56,7 +56,7 @@ export interface Request extends RequestBase { */ input: string | Array /** - * Optional task settings + * Task settings for the individual inference request. These settings are specific to the you specified and override the task settings specified when initializing the service. */ task_settings?: TaskSettings } diff --git a/specification/inference/stream_completion/StreamInferenceRequest.ts b/specification/inference/stream_completion/StreamInferenceRequest.ts index 0e08af6a6f..3802b8f2d2 100644 --- a/specification/inference/stream_completion/StreamInferenceRequest.ts +++ b/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 you specified and override the task settings specified when initializing the service. */ task_settings?: TaskSettings } diff --git a/specification/inference/text_embedding/TextEmbeddingRequest.ts b/specification/inference/text_embedding/TextEmbeddingRequest.ts index 48a48792c8..ef1a537b26 100644 --- a/specification/inference/text_embedding/TextEmbeddingRequest.ts +++ b/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 you specified and override the task settings specified when initializing the service. */ task_settings?: TaskSettings }