Este tema describe cómo obtener uno o varios documentos de una colección a partir de su ID o de una lista de IDs mediante el SDK para Python.
Si el ID especificado no existe, la salida correspondiente queda vacía.
Requisitos previos
A cluster is created. For more information, see Create a cluster.
An API key is obtained. For more information, see Manage API keys.
Instale la versión más reciente del SDK. Para más información, consulte Install DashVector SDK.
Definición de la API
collection.fetch(
ids: Union[str, List[str]],
partition: Optional[str] = None,
async_req: bool = False
) -> DashVectorResponseEjemplo
Reemplace
YOUR_API_KEYpor su clave de API yYOUR_CLUSTER_ENDPOINTpor el endpoint de su clúster en el código de ejemplo para que se ejecute correctamente.Cree previamente una colección llamada
quickstart. Para más información, consulte la sección "Ejemplo" del tema Create a collection. También inserte algunos documentos de antemano; para más información, consulte Insert documents.
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 de solicitud
|
Parámetro |
Tipo |
Valor predeterminado |
Descripción |
|
ids |
Union[Union[str, int], List[Union[str, int]]] |
- |
La clave primaria o la lista de claves primarias. |
|
partition |
Optional[str] |
None |
Opcional. El nombre de la partición. |
|
async_req |
bool |
False |
Opcional. Indica si se habilite el modo asíncrono. |
Parámetros de respuesta
Se devuelve un objeto DashVectorResponse que contiene el resultado de la operación, tal como se describe a continuación.
|
Parámetro |
Tipo |
Descripción |
Ejemplo |
|
code |
int |
El código de estado devuelto. Para más información, consulte Status codes. |
0 |
|
message |
str |
El mensaje devuelto. |
success |
|
request_id |
str |
El ID único de la solicitud. |
19215409-ea66-4db9-8764-26ce2eb5bb99 |
|
output |
Dict[str, Doc] |
Diccionario cuya clave es la clave primaria y cuyo valor es un objeto Doc. |