As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Cohere Embed v3
**Topics**
+ [Solicitação e reposta](#model-parameters-embed-v3-request-response)
+ [Exemplo de código](#api-inference-examples-cohere-embed-v3)
## Solicitação e reposta
------
#### [ Request ]
Os modelos Embed da Cohere têm os parâmetros de inferência a seguir.
```
{
"input_type": "search_document|search_query|classification|clustering|image",
"texts":[string],
"images":[image_base64_image_uri]
"truncate": "NONE|START|END",
"embedding_types": embedding_types
}
```
Veja a seguir os parâmetros necessários.
+ **textos**: uma matriz de strings para o modelo incorporar. Para uma performance ideal, é recomendável reduzir o tamanho de cada texto para menos de 512 tokens. um token tem cerca de quatro caracteres.
Veja os limites de texto por chamada e por caracteres.
**Textos por chamada**
[See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/bedrock/latest/userguide/model-parameters-embed-v3.html)
**Caracteres**
[See the AWS documentation website for more details](http://docs.aws.amazon.com/pt_br/bedrock/latest/userguide/model-parameters-embed-v3.html)
+ **input\_type**: preceda tokens especiais para diferenciar um tipo do outro. Não misture tipos diferentes em conjunto, exceto ao misturar tipos para pesquisa e recuperação. Nesse caso, incorpore seu corpus com o tipo `search_document` e as consultas incorporadas com o tipo `search_query`.
+ `search_document`: em casos de uso de pesquisa, use `search_document` ao codificar documentos para incorporações que você armazena em um banco de dados de vetores.
+ `search_query`: use `search_query` ao consultar o banco de dados de vetores para encontrar documentos relevantes.
+ `classification`: use `classification` ao usar incorporações como entrada para um classificador de texto.
+ `clustering`: use `clustering` para agrupar as incorporações.
+ `images`: essa é uma matriz de imagens.
+ Uma matriz de URIs de dados de imagem para o modelo incorporar. O número máximo de imagens por chamada é 1 (ou seja, o modelo comporta apenas uma entrada de imagem).
+ A imagem deve ser um URI de dados válido. A imagem deve estar no formato image/jpeg ou image/png e ter o tamanho máximo de 5 MB.
+ Somente uma das “imagens” ou um dos “textos” deve ser fornecidos.
Veja os seguintes parâmetros opcionais:
+ **truncate**: especifica como a API lida com entradas maiores que o tamanho máximo do token. Use uma das seguintes opções:
+ `NONE`: (padrão) retorna um erro quando a entrada excede o tamanho máximo do token de entrada.
+ `START`: descarta o início da entrada.
+ `END`: descarta o final da entrada.
Se você especificar `START` ou `END`, o modelo descartará a entrada até que a entrada restante tenha exatamente o tamanho máximo do token de entrada para o modelo.
+ **embedding\_types**: especifica os tipos de incorporação que você deseja que sejam exibidos. Opcional, e o padrão é `None`, que exibe o tipo de resposta `Embed Floats`. O tipo pode ser um ou mais dos seguintes:
+ `float`: usar esse valor para retornar as incorporações flutuantes padrão.
+ `int8`: usar esse valor para retornar incorporações int8 assinadas.
+ `uint8`: usar esse valor para retornar incorporações int8 não assinadas.
+ `binary`: usar esse valor para retornar incorporações binárias assinadas.
+ `ubinary`: usar esse valor para retornar incorporações binárias não assinadas.
Para obter mais informações, consulte [https://docs.cohere.com/reference/embed](https://docs.cohere.com/reference/embed) na documentação da Cohere.
------
#### [ Response ]
A resposta `body` de uma chamada para `InvokeModel` é a seguinte:
```
{
"embeddings": [
[ {{array of 1024 floats.}} ]
],
"id": string,
"response_type" : "embeddings_floats,
"texts": [string],
"images": [image_description]
}
```
A resposta do `body` tem os seguintes campos:
+ **id**: um identificador para a resposta.
+ **response\_type**: o tipo de resposta. Esse valor é sempre `embeddings_floats`.
+ **embeddings**: uma matriz de incorporações, em que cada incorporação é uma matriz de flutuadores com 1.024 elementos. O comprimento da matriz `embeddings` será igual ao comprimento da matriz `texts` original.
+ **texts**: uma matriz contendo as entradas de texto para as quais as incorporações foram retornadas.
+ **images**: uma matriz de uma descrição para cada entrada de imagem.
Uma `image_description`image\_description tem o seguinte formato:
```
{
"width": long,
"height": long,
"format": string,
"bit_depth": long
}
```
Se a imagem foi usada como entrada, o campo de resposta `“texts”` será uma matriz vazia. O contrário não é verdadeiro (isto é, quando são usados textos, não haverá `“images”` na resposta).
Para ter mais informações, consulte [https://docs.cohere.com/reference/embed](https://docs.cohere.com/reference/embed).
------
## Exemplo de código
Este exemplo mostra como chamar o modelo *Embed English da Cohere*.
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Shows how to generate text embeddings using the Cohere Embed English model.
"""
import json
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
logging.basicConfig(level=logging.INFO)
def generate_text_embeddings(model_id, body, region_name):
"""
Generate text embedding by using the Cohere Embed model.
Args:
model_id (str): The model ID to use.
body (str) : The reqest body to use.
region_name (str): The AWS region to invoke the model on
Returns:
dict: The response from the model.
"""
logger.info("Generating text embeddings with the Cohere Embed model %s", model_id)
accept = '*/*'
content_type = 'application/json'
bedrock = boto3.client(service_name='bedrock-runtime', region_name=region_name)
response = bedrock.invoke_model(
body=body,
modelId=model_id,
accept=accept,
contentType=content_type
)
logger.info("Successfully generated embeddings with Cohere model %s", model_id)
return response
def main():
"""
Entrypoint for Cohere Embed example.
"""
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
region_name = 'us-east-1'
model_id = 'cohere.embed-english-v3'
text1 = "hello world"
text2 = "this is a test"
input_type = "search_document"
embedding_types = ["int8", "float"]
try:
body = json.dumps({
"texts": [
text1,
text2],
"input_type": input_type,
"embedding_types": embedding_types
})
response = generate_text_embeddings(model_id=model_id, body=body, region_name=region_name)
response_body = json.loads(response.get('body').read())
print(f"ID: {response_body.get('id')}")
print(f"Response type: {response_body.get('response_type')}")
print("Embeddings")
embeddings = response_body.get('embeddings')
for i, embedding_type in enumerate(embeddings):
print(f"\t{embedding_type} Embeddings:")
print(f"\t{embeddings[embedding_type]}")
print("Texts")
for i, text in enumerate(response_body.get('texts')):
print(f"\tText {i}: {text}")
except ClientError as err:
message = err.response["Error"]["Message"]
logger.error("A client error occurred: %s", message)
print("A client error occured: " +
format(message))
else:
print(
f"Finished generating text embeddings with Cohere model {model_id}.")
if __name__ == "__main__":
main()
```
**Entrada de imagem**
```
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Shows how to generate image embeddings using the Cohere Embed English model.
"""
import json
import logging
import boto3
import base64
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
logging.basicConfig(level=logging.INFO)
def get_base64_image_uri(image_file_path: str, image_mime_type: str):
with open(image_file_path, "rb") as image_file:
image_bytes = image_file.read()
base64_image = base64.b64encode(image_bytes).decode("utf-8")
return f"data:{image_mime_type};base64,{base64_image}"
def generate_image_embeddings(model_id, body, region_name):
"""
Generate image embedding by using the Cohere Embed model.
Args:
model_id (str): The model ID to use.
body (str) : The reqest body to use.
region_name (str): The AWS region to invoke the model on
Returns:
dict: The response from the model.
"""
logger.info("Generating image embeddings with the Cohere Embed model %s", model_id)
accept = '*/*'
content_type = 'application/json'
bedrock = boto3.client(service_name='bedrock-runtime', region_name=region_name)
response = bedrock.invoke_model(
body=body,
modelId=model_id,
accept=accept,
contentType=content_type
)
logger.info("Successfully generated embeddings with Cohere model %s", model_id)
return response
def main():
"""
Entrypoint for Cohere Embed example.
"""
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
region_name = 'us-east-1'
image_file_path = "image.jpg"
image_mime_type = "image/jpg"
model_id = 'cohere.embed-english-v3'
input_type = "image"
images = [get_base64_image_uri(image_file_path, image_mime_type)]
embedding_types = ["int8", "float"]
try:
body = json.dumps({
"images": images,
"input_type": input_type,
"embedding_types": embedding_types
})
response = generate_image_embeddings(model_id=model_id, body=body, region_name=region_name)
response_body = json.loads(response.get('body').read())
print(f"ID: {response_body.get('id')}")
print(f"Response type: {response_body.get('response_type')}")
print("Embeddings")
embeddings = response_body.get('embeddings')
for i, embedding_type in enumerate(embeddings):
print(f"\t{embedding_type} Embeddings:")
print(f"\t{embeddings[embedding_type]}")
print("Texts")
for i, text in enumerate(response_body.get('texts')):
print(f"\tText {i}: {text}")
except ClientError as err:
message = err.response["Error"]["Message"]
logger.error("A client error occurred: %s", message)
print("A client error occured: " +
format(message))
else:
print(
f"Finished generating text embeddings with Cohere model {model_id}.")
if __name__ == "__main__":
main()
```