Saltar al contenido principal
POST
CSharp (SDK)

Autorizaciones

Authorization
string
header
requerido

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Encabezados

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parámetros de ruta

connector_id
string
requerido

El id del conector.

Cuerpo

application/json
vector_store_id
string
requerido

La tienda a vincular. Los archivos actuales del conector se adjuntan a ella de inmediato.

Respuesta

200 - application/json

Está bien

id
string
requerido

El id del conector, con el prefijo vsc_.

object
any
requerido
type
enum<string>
requerido

El tipo de ubicación. s3 es un bucket en AWS S3 o almacenamiento compatible con S3. sharepoint es una biblioteca de documentos de un sitio de SharePoint Online.

Opciones disponibles:
s3,
sharepoint
name
string
requerido
location
object
requerido

Dónde lee el conector, en la forma de su type. Fijo en la creación.

credentials_configured
any
requerido

Las credenciales son de solo escritura; esto indica que una credencial está almacenada.

api_key_id
string
requerido

El ID de la clave de API con la que se ejecutan las sincronizaciones del conector: el ID de la clave, nunca su secreto. Solo cambia cuando se realiza una llamada de actualización con otra clave del mismo principal.

include_patterns
string[]
requerido
exclude_patterns
string[]
requerido
chunking_strategy
object
requerido

La fragmentación que recibe cada archivo reflejado. Nulo significa la estrategia automática de la puerta de enlace. Fijado al crearse.

auto_sync
boolean
requerido
sync_interval_minutes
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
next_sync_at
integer | null
requerido

Nulo mientras la sincronización automática está desactivada o no hay ninguna tienda vinculada.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
requerido

sincronizando mientras una ejecución está en progreso, eliminando mientras una eliminación o desincronización está en progreso, error cuando la última ejecución falló, de lo contrario inactivo.

Opciones disponibles:
idle,
syncing,
removing,
error
last_error
string | null
requerido
last_run
object | null
requerido
vector_store_ids
string[]
requerido
created_at
integer
requerido

Cuando se creó el conector (segundos Unix).

Rango requerido: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
requerido

Cuando se cambió por última vez el conector (segundos de Unix).

Rango requerido: -9007199254740991 <= x <= 9007199254740991