"embed-text-dedicated-serving-mode"
***********************************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


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

Produces embeddings for the inputs.

An embedding is numeric representation of a piece of text. This text
can be a phrase, a sentence, or one or more paragraphs. The Generative
AI embedding model transforms each phrase, sentence, or paragraph that
you input, into an array with 1024 numbers. You can use these
embeddings for finding similarity in your input text such as finding
phrases that are similar in context or category. Embeddings are mostly
used for semantic searches where the search function focuses on the
meaning of the text that it’s searching through rather than finding
results based on keywords.


Usage
=====

   oci generative-ai-inference embed-text-result embed-text-dedicated-serving-mode [OPTIONS]


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

--compartment-id, -c [text]

The OCID of compartment that the user is authorized to use to call
into the Generative AI service.

--inputs [complex type]

The list of strings for embeddings. 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.

--serving-mode-endpoint-id [text]

The OCID of the endpoint to use.


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

--input-type [text]

Specifies the input type.

Accepted values are:

   CLASSIFICATION, CLUSTERING, SEARCH_DOCUMENT, SEARCH_QUERY

--is-echo [boolean]

Whether or not to include the original inputs in the response. Results
are index-based.

--truncate [text]

For an input that’s longer than the maximum token length, specifies
which part of the input text will be truncated.

Accepted values are:

   END, NONE, START


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", "--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 embed-text-result embed-text-dedicated-serving-mode --generate-param-json-input inputs > inputs.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/embed-text-result/embed-text-dedicated-serving-mode.html#cmdoption-compartment-id
       export serving_mode_endpoint_id=<substitute-value-of-serving_mode_endpoint_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-inference/embed-text-result/embed-text-dedicated-serving-mode.html#cmdoption-serving-mode-endpoint-id

       oci generative-ai-inference embed-text-result embed-text-dedicated-serving-mode --compartment-id $compartment_id --inputs file://inputs.json --serving-mode-endpoint-id $serving_mode_endpoint_id
