bedrockruntime_invoke_model_with_response_stream: Invoke the specified Amazon Bedrock model to run inference...

View source: R/bedrockruntime_operations.R

bedrockruntime_invoke_model_with_response_streamR Documentation

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body

Description

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

See https://www.paws-r-sdk.com/docs/bedrockruntime_invoke_model_with_response_stream/ for full documentation.

Usage

bedrockruntime_invoke_model_with_response_stream(
  body,
  contentType = NULL,
  accept = NULL,
  modelId,
  trace = NULL,
  guardrailIdentifier = NULL,
  guardrailVersion = NULL
)

Arguments

body

[required] The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

contentType

The MIME type of the input data in the request. You must specify application/json.

accept

The desired MIME type of the inference body in the response. The default value is application/json.

modelId

[required] The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

trace

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

guardrailIdentifier

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.

An error is thrown in the following situations.

  • You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

  • You enable the guardrail but the contentType isn't application/json.

  • You provide a guardrail identifier, but guardrailVersion isn't specified.

guardrailVersion

The version number for the guardrail. The value can also be DRAFT.


paws.machine.learning documentation built on Sept. 12, 2024, 6:23 a.m.