Skip to main content

aws_sdk_sagemakerjobruntime/client/
sample.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`Sample`](crate::operation::sample::builders::SampleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_arn(impl Into<String>)`](crate::operation::sample::builders::SampleFluentBuilder::job_arn) / [`set_job_arn(Option<String>)`](crate::operation::sample::builders::SampleFluentBuilder::set_job_arn):<br>required: **true**<br>The job ARN that identifies which model session to route the inference request to.<br>
7    ///   - [`trajectory_id(impl Into<String>)`](crate::operation::sample::builders::SampleFluentBuilder::trajectory_id) / [`set_trajectory_id(Option<String>)`](crate::operation::sample::builders::SampleFluentBuilder::set_trajectory_id):<br>required: **true**<br>The trajectory ID for grouping turns into a single rollout. Each turn (prompt and response) is captured for later use.<br>
8    ///   - [`body(Blob)`](crate::operation::sample::builders::SampleFluentBuilder::body) / [`set_body(Option<Blob>)`](crate::operation::sample::builders::SampleFluentBuilder::set_body):<br>required: **true**<br>The raw inference request body in OpenAI-compatible JSON format.<br>
9    /// - On success, responds with [`SampleOutput`](crate::operation::sample::SampleOutput) with field(s):
10    ///   - [`content_type(Option<String>)`](crate::operation::sample::SampleOutput::content_type): MIME type of the inference result.
11    ///   - [`body(Blob)`](crate::operation::sample::SampleOutput::body): The raw inference response body from the model.
12    /// - On failure, responds with [`SdkError<SampleError>`](crate::operation::sample::SampleError)
13    pub fn sample(&self) -> crate::operation::sample::builders::SampleFluentBuilder {
14        crate::operation::sample::builders::SampleFluentBuilder::new(self.handle.clone())
15    }
16}