Skip to content

Commit 02aaaa3

Browse files
prwhelanjonathan-buttnerszabosteve
authored
Apply suggestions from code review
Co-authored-by: Jonathan Buttner <[email protected]> Co-authored-by: István Zoltán Szabó <[email protected]>
1 parent ebeaa64 commit 02aaaa3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

specification/inference/_types/CommonTypes.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -444,11 +444,11 @@ export enum AmazonBedrockServiceType {
444444

445445
export class AmazonSageMakerServiceSettings {
446446
/**
447-
* A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoke requests.
447+
* A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests.
448448
*/
449449
access_key: string
450450
/**
451-
* The name of the SageMaker Endpoint.
451+
* The name of the SageMaker endpoint.
452452
* @ext_doc_id amazonsagemaker-invoke
453453
*/
454454
endpoint_name: string
@@ -458,19 +458,19 @@ export class AmazonSageMakerServiceSettings {
458458
*/
459459
api: AmazonSageMakerApi
460460
/**
461-
* The region that your endpoint or ARN is deployed in.
461+
* The region that your endpoint or Amazon Resource Name (ARN) is deployed in.
462462
* The list of available regions per model can be found in the Amazon SageMaker documentation.
463463
* @ext_doc_id amazonsagemaker-invoke
464464
*/
465465
region: string
466466
/**
467467
* A valid AWS secret key that is paired with the `access_key`.
468-
* For informationg about creating and managing access and secret keys, refer to the AWS documentation.
468+
* For information about creating and managing access and secret keys, refer to the AWS documentation.
469469
* @ext_doc_id amazonsagemaker-secret-keys
470470
*/
471471
secret_key: string
472472
/**
473-
* The model id when calling a multi-model endpoint.
473+
* The model ID when calling a multi-model endpoint.
474474
* @ext_doc_id amazonsagemaker-invoke
475475
*/
476476
target_model?: string
@@ -492,8 +492,8 @@ export class AmazonSageMakerServiceSettings {
492492
*/
493493
batch_size?: integer
494494
/**
495-
* The number of dimensions returned by the text_embedding models. If this value is not provided, then
496-
* it is guessed by making invoking the Endpoint for the text_embedding task.
495+
* The number of dimensions returned by the text embedding models. If this value is not provided, then
496+
* it is guessed by making invoking the endpoint for the `text_embedding` task.
497497
*/
498498
dimensions?: integer
499499
}
@@ -504,17 +504,17 @@ export enum AmazonSageMakerApi {
504504
}
505505

506506
/**
507-
* Service Settings specific to the Elastic API for the Amazon SageMaker service.
507+
* Service settings specific to the Elastic API for the Amazon SageMaker service.
508508
*/
509509
export class AmazonSageMakerElasticServiceSettings extends AmazonSageMakerServiceSettings {
510510
/**
511-
* Similarity measure used when invoking the text_embedding task type.
511+
* Similarity measure used when invoking the `text_embedding` task type.
512512
*/
513513
similarity?: AmazonSageMakerSimilarity
514514

515515
/**
516-
* The data type returned by the text_embedding model.
517-
* This value must be set when task_type is text_embedding and is used when parsing the response
516+
* The data type returned by the text embedding model.
517+
* This value must be set when `task_type` is `text_embedding` and is used when parsing the response
518518
* back to Elasticsearch data structures.
519519
*/
520520
element_type: AmazonSageMakerElementType
@@ -545,7 +545,7 @@ export interface AmazonSageMakerTaskSettings {
545545
*/
546546
enable_explanations?: string
547547
/**
548-
* The capture data id when enabled in the Endpoint.
548+
* The capture data ID when enabled in the endpoint.
549549
* @ext_doc_id amazonsagemaker-invoke
550550
*/
551551
inference_id?: string

0 commit comments

Comments
 (0)