"apply-guardrails-guardrails-image-input"
*****************************************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Applies guardrails to the input content, including content moderation,
PII detection, and prompt injection protection. Case 1: Use *input*
when the customer wants simple single-text moderation. Existing
customers can continue to use this field without changing their
current integration. Case 2: Use *multimodalInput* when the customer
wants moderation over text, image, or a combination of both.
*multimodalInput* supports a single text item, an array of text items
only, an array of images only, or a mixed ordered combination of text
and image items. Clients may provide *input*, *multimodalInput*, or
both. At least one of these fields must be provided. If both *input*
and *multimodalInput* are provided, the service will process *input*
and discard *multimodalInput*.


Usage
=====

   oci generative-ai-inference apply-guardrails-result apply-guardrails-guardrails-image-input [OPTIONS]


Required Parameters
===================

--compartment-id, -c [text]

The OCID of the compartment to apply guardrails.

--guardrail-configs [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


Optional Parameters
===================

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--guardrail-version-config [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--input-image-url [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--multimodal-input [complex type]

An ordered list of text and image inputs for multimodal guardrail
evaluation. This field supports a single text item, an array of text
items only, an array of images only, or a mixed ordered combination of
text and image items. If both *input* and *multimodalInput* are
provided, this field is ignored.

This option is a JSON list with items of type GuardrailsInput.  For
documentation on GuardrailsInput please see our API reference:
https://docs.oracle.com/en-us/iaas/api/#/en/generativeaiinference/202
31130/datatypes/GuardrailsInput. This is a complex type whose value
must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--enable-dual-stack", "--enable-propagation", "--
endpoint", "--generate-full-command-json-input", "--generate-param-
json-input", "--help", "--latest-version", "--max-retries", "--no-
retry", "--opc-client-request-id", "--opc-request-id", "--output", "--
profile", "--proxy", "--query", "--raw-output", "--read-timeout", "--
realm-specific-endpoint", "--region", "--release-info", "--request-
id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy and paste the following example into a JSON file, replacing the
example parameters with your own.

       oci generative-ai-inference apply-guardrails-result apply-guardrails-guardrails-image-input --generate-param-json-input guardrail-configs > guardrail-configs.json

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-inference/apply-guardrails-result/apply-guardrails-guardrails-image-input.html#cmdoption-compartment-id

       oci generative-ai-inference apply-guardrails-result apply-guardrails-guardrails-image-input --compartment-id $compartment_id --guardrail-configs file://guardrail-configs.json
