bedrock
for Amazon Bedrock. Learn more.huggingface
for Hugging Face. Learn more.mixedbread-ai
for Mixedbread. Learn more.octoai
for Octo AI. Learn more.openai
for OpenAI. Learn more.togetherai
for Together.ai. Learn more.vertexai
for Google Vertex AI PaLM. Learn more.voyageai
for Voyage AI. Learn more.bedrock
, run pip install "unstructured-ingest[bedrock]"
.huggingface
, run pip install "unstructured-ingest[embed-huggingface]"
.mixedbread-ai
, run pip install "unstructured-ingest[embed-mixedbreadai]"
.octoai
, run pip install "unstructured-ingest[embed-octoai]"
.openai
, run pip install "unstructured-ingest[openai]"
.togetherai
, run pip install "unstructured-ingest[togetherai]"
.vertexai
, run pip install "unstructured-ingest[embed-vertexai]"
.voyageai
, run pip install "unstructured-ingest[embed-voyageai]"
.bedrock
. Choose a model. No default model is provided. Learn more about the supported models.huggingface
. Choose a model, or use the default model sentence-transformers/all-MiniLM-L6-v2.mixedbread-ai
. Choose a model, or use the default model mixedbread-ai/mxbai-embed-large-v1.octoai
. Choose a model, or use the default model thenlper/gte-large
.openai
. Choose a model, or use the default model text-embedding-ada-002
.togetherai
. Choose a model, or use the default model togethercomputer/m2-bert-80M-32k-retrieval
.vertexai
. Choose a model, or use the default model text-embedding-05
.voyageai
. Choose a model. No default model is provided.bedrock
, you’ll need an AWS access key value, the corresponding AWS secret access key value, and the corresponding AWS Region identifier. Get an AWS access key and secret access key.huggingface
, if you use a gated model (a model with special conditions that you must accept before you can use it, or a privately published model), you’ll need an HF inference API key value, beginning with hf_
. Get an HF inference API key. To learn whether your model requires an HF inference API key, see your model provider’s documentation.mixedbread-ai
, you’ll need a Mixedbread API key value. Get a Mixedbread API key.octoai
, you’ll need an Octo AI API token value. Get an Octo AI API token.openai
, you’ll need an OpenAI API key value. Get an OpenAI API key.togetherai
, you’ll need a together.ai API key value. Get a together.ai API key.vertexai
, you’ll need the path to a Google Cloud credentials JSON file. Learn more here and here.voyageai
, you’ll need a Voyage AI API key value. Get a Voyage AI API key.Ingest CLI
--embedding-api-key
--embedding-aws-access-key-id
--embedding-aws-secret-access-key
--embedding-aws-region
--embedding-provider
to the provider’s ID, for example huggingface
.
--embedding-model-name
to the model name, as applicable, for example sentence-transformers/sentence-t5-xl
. Or omit this to use the default model, as applicable.
--embedding-api-key
to the provider’s required API key value or credentials JSON file path, as appropriate.
bedrock
:
--embedding-aws-access-key-id
to the AWS access key value.--embedding-aws-secret-access-key
to the corresponding AWS secret access key value.--embedding-aws-region
to the corresponding AWS Region identifier.Ingest Python library
embedding_api_key
embedding_aws_access_key_id
embedding_aws_secret_access_key
embedding_aws_region
EmbedderConfig
object:embedding_provider
parameter to the provider’s ID, for example huggingface
.
embedding_model_name
to the model name, as applicable, for example sentence-transformers/sentence-t5-xl
. Or omit this to use the default model, as applicable.
embedding_api_key
to the provider’s required API key value or credentials JSON file path, as appropriate.
bedrock
:
embedding_aws_access_key_id
to the AWS access key value.embedding_aws_secret_access_key
to the corresponding AWS secret access key value.embedding_aws_region
to the corresponding AWS Region identifier.