Pular para o conteúdo principal
POST
CSharp (SDK)

Autorizações

Authorization
string
header
obrigatório

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.

Cabeçalhos

X-On-Behalf-Of
string

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

Corpo

application/json
type
any
obrigatório
location
object
obrigatório
credentials
object
obrigatório

Um par de chaves de acesso somente leitura para o bucket. Somente gravação: nunca retornado.

name
string
obrigatório
Required string length: 1 - 255
include_patterns
string[]

Um glob relativo ao prefixo do conector: * dentro de uma pasta, ** entre pastas, ? um caractere, [abc] um conjunto; barra invertida para escape. Todo os outros caracteres são literais.

Minimum string length: 1
exclude_patterns
string[]

Um glob relativo ao prefixo do conector: * dentro de uma pasta, ** entre pastas, ? um caractere, [abc] um conjunto; barra invertida para escape. Todo os outros caracteres são literais.

Minimum string length: 1
chunking_strategy
object

A segmentação automática da gateway.

auto_sync
boolean
padrão:true

Ligado: sincroniza a cada intervalo. Desligado: apenas quando solicitado.

sync_interval_minutes
integer

Minutos entre sincronizações enquanto auto_sync está ativado, de 15 a 10080. O padrão é o do operador, 60, a menos que seja alterado.

Intervalo obrigatório: 15 <= x <= 10080
vector_store_ids
string[]

Lojas para vincular na criação. Com auto_sync ativado, a primeira sincronização começa imediatamente.

Resposta

200 - application/json

OK

id
string
obrigatório

O ID do conector, prefixado com vsc_.

object
any
obrigatório
type
enum<string>
obrigatório

O tipo de local. s3 é um bucket no AWS S3 ou em armazenamento compatível com S3. sharepoint é uma biblioteca de documentos de um site do SharePoint Online.

Opções disponíveis:
s3,
sharepoint
name
string
obrigatório
location
object
obrigatório

Onde o conector lê, no formato do seu type. Fixo na criação.

credentials_configured
any
obrigatório

As credenciais são de gravação apenas; isto diz que uma credencial está armazenada.

api_key_id
string
obrigatório

O ID da chave de API com a qual as sincronizações do conector são executadas: o ID da chave, nunca seu segredo. Ele só muda quando é feita uma chamada de atualização com outra chave do mesmo principal.

include_patterns
string[]
obrigatório
exclude_patterns
string[]
obrigatório
chunking_strategy
object
obrigatório

O particionamento que cada arquivo espelhado recebe. Null significa a estratégia automática do gateway. Fixo na criação.

auto_sync
boolean
obrigatório
sync_interval_minutes
integer
obrigatório
Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
next_sync_at
integer | null
obrigatório

Nulo enquanto o auto_sync estiver desativado ou nenhum armazenamento estiver vinculado.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
obrigatório

sincronizando enquanto uma execução está em andamento, removendo enquanto uma exclusão ou dessincronização está em andamento, erro quando a última execução falhou, caso contrário, inativo.

Opções disponíveis:
idle,
syncing,
removing,
error
last_error
string | null
obrigatório
last_run
object | null
obrigatório
vector_store_ids
string[]
obrigatório
created_at
integer
obrigatório

Quando o conector foi criado (segundos Unix).

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
obrigatório

Quando o conector foi alterado pela última vez (segundos Unix).

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991