Skip to content

Commit a8f2e2a

Browse files
authored
Amazon Bedrock models: change aws-bedrock to just bedrock (#479)
1 parent 6ef4009 commit a8f2e2a

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

api-reference/how-to/embedding.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To use the Ingest CLI or Ingest Python library to generate embeddings, do the fo
4343

4444
1. Choose an embedding provider that you want to use from among the following allowed providers, and note the provider's ID:
4545

46-
- The provider ID `aws-bedrock` for [Amazon Bedrock](https://aws.amazon.com/bedrock/). [Learn more](https://python.langchain.com/v0.2/docs/integrations/text_embedding/bedrock/).
46+
- The provider ID `bedrock` for [Amazon Bedrock](https://aws.amazon.com/bedrock/). [Learn more](https://python.langchain.com/v0.2/docs/integrations/text_embedding/bedrock/).
4747
- `huggingface` for [Hugging Face](https://huggingface.co/). [Learn more](https://python.langchain.com/v0.2/docs/integrations/text_embedding/huggingfacehub/).
4848
- `mixedbread-ai` for [Mixedbread](https://www.mixedbread.ai/). [Learn more](https://www.mixedbread.ai/docs/embeddings/overview).
4949
- `octoai` for [Octo AI](https://octo.ai/). [Learn more](https://octo.ai/docs/text-gen-solution/using-unstructured-io-for-embedding-documents).
@@ -54,7 +54,7 @@ To use the Ingest CLI or Ingest Python library to generate embeddings, do the fo
5454

5555
2. Run the following command to install the required Python package for the embedding provider:
5656

57-
- For `aws-bedrock`, run `pip install "unstructured-ingest[bedrock]"`.
57+
- For `bedrock`, run `pip install "unstructured-ingest[bedrock]"`.
5858
- For `huggingface`, run `pip install "unstructured-ingest[embed-huggingface]"`.
5959
- For `mixedbread-ai`, run `pip install "unstructured-ingest[embed-mixedbreadai]"`.
6060
- For `octoai`, run `pip install "unstructured-ingest[embed-octoai]"`.
@@ -65,7 +65,7 @@ To use the Ingest CLI or Ingest Python library to generate embeddings, do the fo
6565

6666
3. For the following embedding providers, you can choose the model that you want to use. If you do choose a model, note the model's name:
6767

68-
- `aws-bedrock`. [Choose a model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html). No default model is provided. [Learn more about the supported models](https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html).
68+
- `bedrock`. [Choose a model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html). No default model is provided. [Learn more about the supported models](https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html).
6969
- `huggingface`. [Choose a model](https://huggingface.co/models?other=embeddings), or use the default model [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2).
7070
- `mixedbread-ai`. [Choose a model](https://www.mixedbread.ai/docs/embeddings/models), or use the default model [mixedbread-ai/mxbai-embed-large-v1](https://www.mixedbread.ai/docs/embeddings/mxbai-embed-large-v1).
7171
- `octoai`. [Choose a model](https://octo.ai/blog/supercharge-rag-performance-using-octoai-and-unstructured-embeddings/), or use the default model `thenlper/gte-large`.
@@ -76,7 +76,7 @@ To use the Ingest CLI or Ingest Python library to generate embeddings, do the fo
7676

7777
4. Note the special settings to connect to the provider:
7878

79-
- For `aws-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](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
79+
- For `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](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
8080
- For `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](https://huggingface.co/docs/api-inference/en/quicktour#get-your-api-token). To learn whether your model requires an HF inference API key, see your model provider's documentation.
8181
- For `mixedbread-ai`, you'll need a Mixedbread API key value. [Get a Mixedbread API key](https://www.mixedbread.ai/dashboard?next=api-keys).
8282
- For `octoai`, you'll need an Octo AI API token value. [Get an Octo AI API token](https://octo.ai/docs/getting-started/how-to-create-octoai-access-token).
@@ -94,7 +94,7 @@ To use the Ingest CLI or Ingest Python library to generate embeddings, do the fo
9494
- Set the command's `--embedding-provider` to the provider's ID, for example `huggingface`.
9595
- Set `--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.
9696
- Set `--embedding-api-key` to the provider's required API key value or credentials JSON file path, as appropriate.
97-
- For `aws-bedrock`:
97+
- For `bedrock`:
9898

9999
- Set `--embedding-aws-access-key-id` to the AWS access key value.
100100
- Set `--embedding-aws-secret-access-key` to the corresponding AWS secret access key value.
@@ -106,7 +106,7 @@ To use the Ingest CLI or Ingest Python library to generate embeddings, do the fo
106106
- Set the `embedding_provider` parameter to the provider's ID, for example `huggingface`.
107107
- Set `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.
108108
- Set `embedding_api_key` to the provider's required API key value or credentials JSON file path, as appropriate.
109-
- For `aws-bedrock`:
109+
- For `bedrock`:
110110

111111
- Set `embedding_aws_access_key_id` to the AWS access key value.
112112
- Set `embedding_aws_secret_access_key` to the corresponding AWS secret access key value.

snippets/ingest-configuration-shared/embedding-configuration.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A common embedding configuration is a critical component that allows for dynamic
1010

1111
* <Icon icon="v"/><Icon icon="1"/>&nbsp;&nbsp;`aws_secret_access_key`: The AWS secret access key to be used for AWS-based embedders, such as Amazon Bedrock.
1212

13-
* <Icon icon="v"/><Icon icon="2"/>&nbsp;&nbsp;`embedding_provider`: The embedding provider to use while doing embedding. Available values include `aws-bedrock`, `azure-openai`, `huggingface`, `mixedbread-ai`, `octoai`, `openai`, `togetherai`, `vertexai`, and `voyageai`.
13+
* <Icon icon="v"/><Icon icon="2"/>&nbsp;&nbsp;`embedding_provider`: The embedding provider to use while doing embedding. Available values include `bedrock`, `azure-openai`, `huggingface`, `mixedbread-ai`, `octoai`, `openai`, `togetherai`, `vertexai`, and `voyageai`.
1414

1515
* <Icon icon="v"/><Icon icon="2"/>&nbsp;&nbsp;`embedding_api_key`: The API key to use, if one is required to generate the embeddings through an API service, such as OpenAI.
1616

@@ -24,12 +24,12 @@ A common embedding configuration is a critical component that allows for dynamic
2424

2525
* <Icon icon="v"/><Icon icon="1"/>&nbsp;&nbsp;`model_name`: The specific model to use for the embedding provider, if necessary.
2626

27-
* <Icon icon="v"/><Icon icon="1"/>&nbsp;&nbsp;`provider`: The embedding provider to use while doing embedding. Available values include `aws-bedrock`, `azure-openai`, `huggingface`, `mixedbread-ai`, `octoai`, `openai`, `togetherai`, `vertexai`, and `voyageai`.
27+
* <Icon icon="v"/><Icon icon="1"/>&nbsp;&nbsp;`provider`: The embedding provider to use while doing embedding. Available values include `bedrock`, `azure-openai`, `huggingface`, `mixedbread-ai`, `octoai`, `openai`, `togetherai`, `vertexai`, and `voyageai`.
2828

2929

3030
<Icon icon="v"/><Icon icon="1"/>&nbsp;&nbsp;The default `model_name` values unless otherwise specified are:
3131

32-
* `aws-bedrock`: None
32+
* `bedrock`: None
3333

3434
* `azure-openai`: `text-embedding-ada-002`, with 1536 dimensions
3535

0 commit comments

Comments
 (0)