Pular para o conteúdo principal
GET
Typescript (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.

Parâmetros de caminho

vector_store_id
string
obrigatório

O ID da loja de vetores à qual o arquivo pertence.

file_id
string
obrigatório

A ID do arquivo sendo recuperado.

Resposta

200 - application/json

OK

Uma lista de arquivos anexados a um armazenamento vetorial.

id
string
obrigatório

O identificador, que pode ser referenciado em endpoints de API.

object
any
obrigatório

O tipo de objeto, que é sempre 'vector_store.file'.

usage_bytes
integer
obrigatório

O uso total do armazenamento vetor em bytes. Observe que isso pode ser diferente do tamanho original do arquivo.

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

O timestamp Unix (em segundos) de quando o arquivo de armazenamento de vetores foi criado.

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

O ID do armazenamento de vetores ao qual o arquivo está anexado.

status
enum<string>
obrigatório

O status do arquivo da loja de vetores. 'em_andamento' significa que está em processamento, 'concluído' indica que o arquivo está pronto para uso, 'cancelado' significa que o processamento foi cancelado, 'falhou' significa que ocorreu um erro.

Opções disponíveis:
in_progress,
completed,
cancelled,
failed
last_error
object | null
obrigatório

O último erro associado a este arquivo de armazenamento de vetores. Será nulo se não houver erros.

filename
string

O nome do arquivo subjacente. Campo de extensão não presente na API da OpenAI; omitido nas respostas de criação.

chunking_strategy
object

A estratégia que a ingestão executou para este arquivo, conforme executada: auto é relatado como os tamanhos estáticos para os quais ele se resolve. Omitido enquanto uma primeira ingestão ainda está em andamento; other para arquivos indexados antes de a estratégia ser registrada.

chunk_count
integer | null

Quantos chunks a ingestão produziu para este arquivo. Campo de extensão não presente na API da OpenAI. Definido assim que o arquivo é dividido em chunks (nulo antes disso e para arquivos indexados antes de isso ser registrado); com processed_chunk_count, ele é exibido como progresso da indexação enquanto o arquivo está em andamento.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
processed_chunk_count
integer | null

Quantos dos chunks do arquivo o ingestão em execução processou até agora: incorporados para stores vetoriais, extraídos como entidades para graph stores. Campo de extensão não presente na API da OpenAI. Nulo até que o arquivo tenha sido dividido em chunks; é igual a chunk_count quando o arquivo é concluído. O arquivo se torna pesquisável quando seu status é completed, e não antes.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
page_count
integer | null

Para um arquivo lido por meio do pipeline de documentos (PDF, Office, imagens): quantas páginas o documento tinha, até o limite de páginas por documento. Campo de extensão não presente na API da OpenAI. Nulo para arquivos de texto simples, antes de o arquivo ter sido lido e para arquivos indexados antes de isso ser registrado.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
processed_page_count
integer | null

Quantas dessas páginas produziram texto. Uma página que o OCR não conseguiu ler é indexada como um espaço reservado e o arquivo ainda é concluído, então um valor abaixo de page_count significa que algumas páginas estão ausentes do índice. Campo de extensão não presente na API da OpenAI. Nulo sempre que page_count for nulo.

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

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. As chaves são strings com um comprimento máximo de 64 caracteres. Os valores são strings com um comprimento máximo de 512 caracteres, booleanos ou números.