PHPackages                             ingestao-vetorial/sdk-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ingestao-vetorial/sdk-php

ActiveLibrary[API Development](/categories/api)

ingestao-vetorial/sdk-php
=========================

Standalone PHP 8.2 SDK for the Ingestão Vetorial API — Guzzle-based, Laravel-compatible.

v0.1.2(1mo ago)00MITPHPPHP ^8.2CI passing

Since Apr 20Pushed 1mo agoCompare

[ Source](https://github.com/ezequiel88/sdk-php-ingestao-vetorial)[ Packagist](https://packagist.org/packages/ingestao-vetorial/sdk-php)[ Docs](https://github.com/ezequiel88/sdk-php-ingestao-vetorial)[ RSS](/packages/ingestao-vetorial-sdk-php/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (3)Versions (2)Used By (0)

sdk-php-ingestao-vetorial
=========================

[](#sdk-php-ingestao-vetorial)

SDK PHP oficial para a API do **Ingestão Vetorial** — sistema de ingestão e busca vetorial com suporte a RAG (Retrieval-Augmented Generation).

Este repositório é a casa dedicada do SDK PHP extraído do monorepo `sdk-ingestao-vetorial`.

Requer PHP 8.2+ e Guzzle 7. Totalmente compatível com **Laravel**, **Symfony** e PHP puro.

Os endpoints paginados da API respondem com `items` e `meta`, mas o SDK continua retornando arrays de DTOs ou strings nos métodos de lista, desempacotando `items` internamente para manter compatibilidade.

---

Índice
------

[](#índice)

- [Requisitos](#requisitos)
- [Instalação](#instala%C3%A7%C3%A3o)
- [Releases automáticos e tags](#releases-autom%C3%A1ticos-e-tags)
- [Início rápido](#in%C3%ADcio-r%C3%A1pido)
- [Integração com Laravel](#integra%C3%A7%C3%A3o-com-laravel)
- [Tratamento de erros](#tratamento-de-erros)
- [DTOs e tipos retornados](#dtos-e-tipos-retornados)
- [Referência completa](#refer%C3%AAncia-completa)
    - [Coleções](#cole%C3%A7%C3%B5es)
    - [Documentos](#documentos)
    - [Upload](#upload)
    - [Busca semântica](#busca-sem%C3%A2ntica)
    - [Tags](#tags)
    - [Estatísticas](#estat%C3%ADsticas)
    - [Progresso de ingestão](#progresso-de-ingest%C3%A3o)
    - [Logs](#logs)
- [Executar testes](#executar-testes)

---

Requisitos
----------

[](#requisitos)

- PHP ≥ 8.2
- `guzzlehttp/guzzle: ^7.0`

---

Instalação
----------

[](#instalação)

```
composer require ingestao-vetorial/sdk-php
```

Atualização no Packagist
------------------------

[](#atualização-no-packagist)

O repositório notifica o Packagist automaticamente a cada push para `main` e também em tags `v*.*.*`, usando o workflow `Sync Packagist metadata`.

Para isso funcionar no GitHub Actions, configure o environment `packagist` com estes secrets:

- `PACKAGIST_USERNAME`
- `PACKAGIST_API_TOKEN`

No Packagist, o pacote deve estar cadastrado apontando para `https://github.com/ezequiel88/sdk-php-ingestao-vetorial`.

Releases automáticos e tags
---------------------------

[](#releases-automáticos-e-tags)

As tags de release do SDK PHP agora devem ser geradas automaticamente pelo workflow `PHP SDK Release Orchestrator`.

Como este repositório foi extraído do monorepo original, a primeira tag automática continua a linhagem anterior a partir da baseline `0.1.1`.

Como funciona:

- Todo PR com mudança relevante em `src/`, `tests/`, `composer.json`, `phpunit.xml` ou `phpstan.neon` deve incluir um arquivo em `.changeset/`.
- O changeset usa a chave `php` com um bump semver: `patch`, `minor` ou `major`.
- Ao entrar na `main`, o workflow valida o SDK, consome os changesets pendentes, cria um commit automático e publica a tag `vX.Y.Z`.
- A tag `vX.Y.Z` dispara o workflow de release do Packagist.

Exemplo de changeset:

```
---
php: patch
---

Corrige a serializacao de payload no upload e ajusta a documentacao.
```

---

Início rápido
-------------

[](#início-rápido)

```