Este tópico descreve como obter um ou mais documentos em uma coleção com base no ID do documento ou em uma lista de IDs usando o SDK para Python.
Se um ID especificado não existir, a saída correspondente será vazia.
Pré-requisitos
Um cluster criado. Para mais informações, consulte Crie um cluster.
Uma chave de API obtida. Para mais informações, consulte Gerencie chaves de API.
A versão mais recente do SDK instalada. Para mais informações, consulte Instale o DashVector SDK.
Definição da API
collection.fetch(
ids: Union[str, List[str]],
partition: Optional[str] = None,
async_req: bool = False
) -> DashVectorResponse
Exemplo
Substitua YOUR_API_KEY pela sua chave de API e YOUR_CLUSTER_ENDPOINT pelo endpoint do seu cluster no código de exemplo para que ele execute corretamente.
Crie antecipadamente uma coleção chamada quickstart. Para mais informações, consulte a seção "Exemplo" do tópico Crie uma coleção. Também é necessário inserir alguns documentos previamente. Para mais informações, consulte Inserir documentos.
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')
doc_id = '1'
docs = collection.fetch(doc_id)
# Check whether the fetch method is successfully called.
if docs:
print('fetch success')
# Check whether the ID of the document to be obtained exists. If not, the corresponding output is empty.
if doc_id in docs:
doc = docs[doc_id]
print(doc.id)
print(doc.vector)
print(doc.fields)
# Traverse all documents and return results.
for id in docs:
print(docs[id])
# Obtain multiple documents at a time.
docs = collection.fetch(['1','2'])
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Valor padrão |
Descrição |
|
ids |
Union[Union[str, int], List[Union[str, int]]] |
- |
Chave primária ou lista de chaves primárias. |
|
partition |
Optional[str] |
None |
Opcional. Nome da partição. |
|
async_req |
bool |
False |
Opcional. Defina se o modo assíncrono deve ser ativado. |
Parâmetros de resposta
Um objeto DashVectorResponse é retornado contendo o resultado da operação, conforme descrito na tabela a seguir.
|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|
code |
int |
Código de status retornado. Para mais informações, consulte Códigos de status. |
0 |
|
message |
str |
Mensagem retornada. |
success |
|
request_id |
str |
ID exclusivo da solicitação. |
19215409-ea66-4db9-8764-26ce2eb5bb99 |
|
output |
Dict[str, Doc] |
Dicionário com a chave definida como chave primária e o valor definido como um objeto Doc. |