> ## Documentation Index
> Fetch the complete documentation index at: https://novita.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# DocsGPT

> Integre a Novita AI ao DocsGPT de forma simples para desbloquear modelos de IA poderosos e aprimorar fluxos de trabalho.

O DocsGPT simplifica a documentação com assistência baseada em IA. Integrá-lo à Novita AI melhora seu desempenho, oferecendo processamento mais rápido, recursos escaláveis e suporte a modelos avançados para aumentar a produtividade.

Este guia mostra como usar o DocsGPT com a Novita AI com base na API da OpenAI, oferecendo uma forma de consultar seu conteúdo e receber respostas personalizadas.

## **Como usar o DocsGPT**

### **Pré-requisitos:**

**Docker:** Certifique-se de que você tenha o [Docker ](https://docs.docker.com/engine/install/)instalado e em execução no seu sistema.

### **Inicializando o DocsGPT (macOS e Linux)**

Para usuários de macOS e Linux, a forma mais fácil de iniciar o DocsGPT é usando o script `setup.sh` fornecido. Esse script automatiza o processo de configuração e oferece várias opções de instalação.

Etapa 1: Baixe o repositório do DocsGPT

* Primeiro, você precisa baixar o repositório do DocsGPT para sua máquina local. Você pode fazer isso usando Git:

```bash theme={"system"}
git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
```

Etapa 2: Execute o script `setup.sh`

* Navegue até o diretório do DocsGPT no seu terminal e execute o script `setup.sh`:

```bash theme={"system"}
./setup.sh
```

Esse script interativo guiará você pela configuração do DocsGPT. Ele oferece quatro opções: usar a API pública, executar localmente, conectar-se a um mecanismo de inferência local ou usar um provedor de API em nuvem. O script configurará automaticamente seu arquivo `.env` e cuidará dos downloads e instalações necessários com base na opção escolhida.

### **Inicializando o DocsGPT (Windows)**

Para usuários do Windows, consulte a [documentação de implantação com Docker](https://docs.docsgpt.cloud/Deploying/Docker-Deploying) para obter instruções detalhadas passo a passo sobre como configurar o DocsGPT usando Docker.

## **Como integrar a API da Novita AI ao DocsGPT**

Etapa 1: Faça login na[ Novita AI ](https://novita.ai)e crie uma [API Key](https://novita.ai/settings/key-management)

<Frame>
  <img src="https://mintcdn.com/novitaai/H3Kjvdvlhgt0Aohj/images/3-1LogintoNovitaAI.png?fit=max&auto=format&n=H3Kjvdvlhgt0Aohj&q=85&s=b5c90a73cd15f73f327bb9c3be6ad701" alt="images/3-1LogintoNovitaAI.png" width="974" height="785" data-path="images/3-1LogintoNovitaAI.png" />
</Frame>

<Frame>
  <img src="https://mintcdn.com/novitaai/H3Kjvdvlhgt0Aohj/images/3-2CreateanAPIKey.png?fit=max&auto=format&n=H3Kjvdvlhgt0Aohj&q=85&s=48e2bd4c6e3642b24b12bff15417b13b" alt="images/3-2CreateanAPIKey.png" width="801" height="484" data-path="images/3-2CreateanAPIKey.png" />
</Frame>

Etapa 2: Selecione a opção 4 e conecte um provedor de API em nuvem no seu terminal

<Frame>
  <img src="https://mintcdn.com/novitaai/H3Kjvdvlhgt0Aohj/images/2SelectOption4andConnectCloudAPIProvider.png?fit=max&auto=format&n=H3Kjvdvlhgt0Aohj&q=85&s=bb8ddd2e4bdebda1e2d69e839823de97" alt="images/2SelectOption4andConnectCloudAPIProvider.png" width="1280" height="592" data-path="images/2SelectOption4andConnectCloudAPIProvider.png" />
</Frame>

Etapa 3: Escolha a opção 7 Novita e insira a chave de API que você acabou de criar

<Frame>
  <img src="https://mintcdn.com/novitaai/H3Kjvdvlhgt0Aohj/images/4ChooseOption7NovitaandEntertheAPIKeyYouJustCreated.png?fit=max&auto=format&n=H3Kjvdvlhgt0Aohj&q=85&s=cfb5b58e584472599f3e9b3c14d4aa8d" alt="images/4ChooseOption7NovitaandEntertheAPIKeyYouJustCreated.png" width="1280" height="660" data-path="images/4ChooseOption7NovitaandEntertheAPIKeyYouJustCreated.png" />
</Frame>

Etapa 4: Aguarde a conclusão do processo de inicialização

<Frame>
  <img src="https://mintcdn.com/novitaai/H3Kjvdvlhgt0Aohj/images/5WaitfortheStartupProcesstoComplete.png?fit=max&auto=format&n=H3Kjvdvlhgt0Aohj&q=85&s=332ea094376d7e01ee8419b7918b821e" alt="images/5WaitfortheStartupProcesstoComplete.png" width="1280" height="577" data-path="images/5WaitfortheStartupProcesstoComplete.png" />
</Frame>

Etapa 5: Acesse o DocsGPT no seu navegador

* Assim que a configuração for concluída e os contêineres Docker estiverem em execução, acesse [`http://localhost:5173/`](http://localhost:5173) no seu navegador da Web para acessar a aplicação Web do DocsGPT.

<Frame>
  <img src="https://mintcdn.com/novitaai/H3Kjvdvlhgt0Aohj/images/6AccesstheApplicationathttp-localhost-5173.jpeg?fit=max&auto=format&n=H3Kjvdvlhgt0Aohj&q=85&s=27b16380d04d4b5b39f6082b7b18b252" alt="images/6AccesstheApplicationathttp-localhost-5173.jpeg" width="3173" height="1749" data-path="images/6AccesstheApplicationathttp-localhost-5173.jpeg" />
</Frame>

Etapa 6: Parando o DocsGPT

* Para parar o DocsGPT, basta abrir um novo terminal no diretório `DocsGPT` e executar:

```bash theme={"system"}
docker compose -f deployment/docker-compose.yaml down
```

* (ou o comando `docker compose` específico mostrado ao final da execução de `setup.sh`, que pode incluir arquivos compose opcionais dependendo das suas escolhas).