Compartir a través de

Vector Stores - Get Vector Store

  • Referencia
Servicio:
AI Foundry
Versión de la API:
v1

Devuelve el objeto de almacén vectorial que coincide con el ID especificado.

GET {endpoint}/vector_stores/{vectorStoreId}?api-version=v1

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string (uri)

Punto final del proyecto en forma de: https://.services.ai.azure.com/api/projects/
vectorStoreId
 path True

string

Identificador del almacén de vectores.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK

VectorStore

La solicitud se ha realizado correctamente.
Other Status Codes

AgentV1Error

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre Description
https://ai.azure.com/.default

Ejemplos

VectorStores_GetVectorStore_MaximumSet
VectorStores_GetVectorStore_MinimumSet

VectorStores_GetVectorStore_MaximumSet

Solicitud de ejemplo

GET {endpoint}/vector_stores/xwdexmgihxptwjnfw?api-version=v1

Respuesta de muestra

status code:
200 
{
  "id": "bxcw",
  "object": "vector_store",
  "created_at": 6,
  "name": "nhjsetafmqp",
  "usage_bytes": 9,
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  },
  "status": "expired",
  "expires_after": {
    "anchor": "last_active_at",
    "days": 102
  },
  "expires_at": 22,
  "last_active_at": 14,
  "metadata": {
    "key1986": "qlxm"
  }
}

VectorStores_GetVectorStore_MinimumSet

Solicitud de ejemplo

GET {endpoint}/vector_stores/czppwfnseyduvnoyls?api-version=v1

Respuesta de muestra

status code:
200 
{
  "id": "bxcw",
  "object": "vector_store",
  "created_at": 6,
  "name": "nhjsetafmqp",
  "usage_bytes": 9,
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  },
  "status": "expired",
  "last_active_at": 14,
  "metadata": {}
}

Definiciones

Nombre Description
AgentErrorDetail

Describe la información de error devuelta por la API de agentes.
AgentV1Error

Carga de error devuelta por la API de agentes.
VectorStore

Un almacén vectorial es una colección de archivos procesados que pueden ser usados por la herramienta file_search.
VectorStoreExpirationPolicy

Directiva de expiración de un almacén de vectores.
VectorStoreExpirationPolicyAnchor

Describe la relación entre los días y la caducidad de este almacén de vectores
VectorStoreFileCount

Recuentos de archivos procesados o procesados por este almacén de vectores agrupados por estado.
VectorStoreStatus

Estado posible del almacenamiento de vectores

AgentErrorDetail

Object

Describe la información de error devuelta por la API de agentes.

Nombre Tipo Description
code

string

Código de error legible por máquina.
message

string

Descripción legible del error.
param

string

Nombre del parámetro que causó el error, si corresponde.
type

string

Identificador de tipo de error (p. ej. invalid_request_error).

AgentV1Error

Object

Carga de error devuelta por la API de agentes.

Nombre Tipo Description
error

AgentErrorDetail

Representa el error.

VectorStore

Object

Un almacén vectorial es una colección de archivos procesados que pueden ser usados por la herramienta file_search.

Nombre Tipo Description
created_at

integer (unixtime)

Marca de tiempo de Unix (en segundos) para cuando se creó el archivo de mensaje.
expires_after

VectorStoreExpirationPolicy

Detalles sobre cuándo expira este almacén de vectores
expires_at

integer (unixtime)

Marca de tiempo de Unix (en segundos) para cuando expire el almacén de vectores.
file_counts

VectorStoreFileCount

Recuento de archivos agrupados por estado procesados o procesados por este almacén de vectores.
id

string

Identificador al que se puede hacer referencia en puntos de conexión de API.
last_active_at

integer (unixtime)

Marca de tiempo de Unix (en segundos) para cuando el almacén de vectores estaba activo por última vez.
metadata

object

Un conjunto de hasta 16 pares clave-valor que se pueden adjuntar a un objeto, que se usan para almacenar información adicional sobre ese objeto en un formato estructurado. Las claves pueden tener hasta 64 caracteres de longitud y los valores pueden tener hasta 512 caracteres de longitud.
name

string

Nombre del almacén de vectores.
object enum:

vector_store

Tipo de objeto, que siempre es vector_store
status

VectorStoreStatus

Estado del almacén de vectores, que puede ser expired, in_progress o completed. Un estado de completed indica que el almacén de vectores está listo para su uso.
usage_bytes

integer (int32)

Número total de bytes usados por los archivos en el almacén de vectores.

VectorStoreExpirationPolicy

Object

Directiva de expiración de un almacén de vectores.

Nombre Tipo Description
anchor

VectorStoreExpirationPolicyAnchor

Marca de tiempo de anclaje después de la cual se aplica la directiva de expiración. Anclajes admitidos: last_active_at.
days

integer (int32)

minimum: 1
maximum: 365

Marca de tiempo de anclaje después de la cual se aplica la directiva de expiración.

VectorStoreExpirationPolicyAnchor

Enumeración

Describe la relación entre los días y la caducidad de este almacén de vectores

Valor Description
last_active_at

La política de expiración se basa en la última vez que el almacén de vectores estuvo activo.

VectorStoreFileCount

Object

Recuentos de archivos procesados o procesados por este almacén de vectores agrupados por estado.

Nombre Tipo Description
cancelled

integer (int32)

Número de archivos cancelados.
completed

integer (int32)

Número de archivos que se han procesado correctamente.
failed

integer (int32)

Número de archivos que no se han podido procesar.
in_progress

integer (int32)

Número de archivos que se están procesando actualmente.
total

integer (int32)

Número total de archivos.

VectorStoreStatus

Enumeración

Estado posible del almacenamiento de vectores

Valor Description
completed

El estado Completado indica que este almacén de vectores está listo para su uso.
expired

El estado Expired indica que este almacén de vectores ha caducado y ya no está disponible para su uso.
in_progress

in_progress estado indica que este almacén de vectores todavía está procesando archivos.