Package io.apicurio.registry.rest.client.groups.item.artifacts.item.versions.item.render

Class RenderRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.groups.item.artifacts.item.versions.item.render.RenderRequestBuilder
@Generated("com.microsoft.kiota") public class RenderRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Render a prompt template artifact by substituting variables.

  • Constructor Details

    • RenderRequestBuilder

      public RenderRequestBuilder(@Nonnull HashMap<String,Object> pathParameters, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new RenderRequestBuilder and sets the default values.
      Parameters:
      pathParameters - Path parameters for the request
      requestAdapter - The request adapter to use to execute the requests.

    • RenderRequestBuilder

      public RenderRequestBuilder(@Nonnull String rawUrl, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new RenderRequestBuilder and sets the default values.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      requestAdapter - The request adapter to use to execute the requests.

  • Method Details

    • post

      @Nullable public RenderPromptResponse post(@Nonnull RenderPromptRequest body)
      Renders a prompt template artifact by substituting the provided variables into the template.The artifact must be of type `PROMPT_TEMPLATE`. Variables are validated against the template'svariable schema before rendering.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* The artifact is not a PROMPT_TEMPLATE (HTTP error `400`)* Required variables are missing or have invalid types (HTTP error `400`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - Request body for rendering a prompt template with variable substitution.
      Returns:
      a RenderPromptResponse
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • post

      @Nullable public RenderPromptResponse post(@Nonnull RenderPromptRequest body, @Nullable Consumer<RenderRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Renders a prompt template artifact by substituting the provided variables into the template.The artifact must be of type `PROMPT_TEMPLATE`. Variables are validated against the template'svariable schema before rendering.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* The artifact is not a PROMPT_TEMPLATE (HTTP error `400`)* Required variables are missing or have invalid types (HTTP error `400`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - Request body for rendering a prompt template with variable substitution.
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RenderPromptResponse
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull RenderPromptRequest body)
      Renders a prompt template artifact by substituting the provided variables into the template.The artifact must be of type `PROMPT_TEMPLATE`. Variables are validated against the template'svariable schema before rendering.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* The artifact is not a PROMPT_TEMPLATE (HTTP error `400`)* Required variables are missing or have invalid types (HTTP error `400`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - Request body for rendering a prompt template with variable substitution.
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull RenderPromptRequest body, @Nullable Consumer<RenderRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Renders a prompt template artifact by substituting the provided variables into the template.The artifact must be of type `PROMPT_TEMPLATE`. Variables are validated against the template'svariable schema before rendering.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* No version with this `version` exists (HTTP error `404`)* The artifact is not a PROMPT_TEMPLATE (HTTP error `400`)* Required variables are missing or have invalid types (HTTP error `400`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - Request body for rendering a prompt template with variable substitution.
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • withUrl

      @Nonnull public RenderRequestBuilder withUrl(@Nonnull String rawUrl)
      Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      Returns:
      a RenderRequestBuilder