> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge/oz-knowledge/pt-br/guias/administrator-guide/configuracao/configuration.md). # Configuração da Oz API As configurações estão contidas no `config.py` arquivo. ## **Configuração inicial** Esses parâmetros são obrigatórios. Observe: se for necessário o modo Instant API (sem dados salvos em nenhum lugar), defina `OZ_APP_COMPONENTS=stateless`. Caso contrário, para salvar dados de pedidos e análises, defina `OZ_APP_COMPONENTS=auth,stateful,oz_collections`, onde: * `auth` é um módulo de autenticação, * `stateful` é um módulo para a API completa, * `oz_collections` é um módulo para a análise de blacklist (remova se não o utilizar). ```python # lista de componentes da aplicação OZ_APP_COMPONENTS=auth,stateful,oz_collections # habilitar suporte ao armazenamento local OZ_LOCAL_STORAGE_SUPPORT_ENABLE=false # host do serviço tfss OZ_SERVICE_TFSS_HOST=http://xxx.xxx.xxx.xxx:xxxx # hosts permitidos APP_ALLOWED_HOSTS=example-host1.com,example-host2.com # chave secreta OZ_API_SECRET_KEY=long_secret_key ``` ## **Conexão com o Postgres** Isso é necessário apenas se você usar a versão completa da API. ```python DB_USER = 'user name' DB_HOST = 'Postgres server address' DB_PASS = 'user password' DB_NAME = 'database name' ``` ## Caminho para os arquivos de mídia Todos os arquivos de mídia recebidos são salvos no diretório local montado em um dos possíveis endpoints, dependendo do método de instalação: * servidor host ou contêiner Docker: `/opt/gateway/static` * no caso do instalador autônomo: `/var/lib/docker/volumes/api_oz-api-static-vol/_data` * qualquer caminho especificado via configuração Na maioria dos casos de integração, os arquivos de mídia podem ser acessados na web usando links diretos para nomes de arquivo gerados aleatoriamente. Para acessar a mídia, é necessário especificar no arquivo de configuração o nome do host externo ou o endereço IP, a porta e o protocolo de conexão. ```python PORT = 443 SCHEME = 'https' HOST = 'api.globalbank.com' ``` ## Conexão com Oz Bio / Liveness ```python OZ_SERVICE_TFSS_HOST = 'http://bio-server-name:8501/v1/' ``` ## Parâmetros de configuração do OzCapsula {% code title="" expandable="true" %} ```py OZ_SESSION_TOKEN_LIFETIME= OZ_JWT_PRIVATE_KEY_PATH= OZ_JWT_PUBLIC_KEY_PATH= OZ_MALEWICZ_ANALYSIS_ENABLED=true ``` {% endcode %} ## Temporização e limites {% hint style="warning" %} Observe: deixamos de oferecer suporte ao Celery na 6.5.0. {% endhint %} ```python # quantidade de tentativas para executar análises no Oz Bio OZ_CELERY_RETRY_MAX_COUNT = 7 # atraso entre as tentativas OZ_CELERY_RETRY_STEP = 30 # tempo máximo de espera de uma análise OZ_ANALYSE_PROCESSING_EXPIRE_TIMEOUT = 15 * 60 # 15 minutos # tempo máximo de espera da análise da API OZ_ANALYSE_DELIVERY_EXPIRE_TIMEOUT = 60 * 60 # 1 hora # frequência para verificar a expiração da análise OZ_ANALYSE_EXPIRE_BEAT_PERIOD = 1 * 60 # a cada minuto # quantidade máxima de mídia anexada OZ_ATTACHMENT_MAX_COUNT = 10 # tamanho máximo de um arquivo de mídia OZ_ATTACHMENT_MAX_SIZE = 24 * 1024 * 1024 # 24 Mb # quantidade de segundos até a expiração do token de acesso OZ_SESSION_TTL = 60 * 15 # 15 minutos # quantidade de segundos até a expiração do token de acesso do serviço OZ_SESSION_LONGLIVE_TTL = 60 * 60 * 24 * 365 * 5 # 5 anos # tamanho máximo da miniatura em bytes OZ_IMAGE_SIZE_THUMBNAIL = 300 # duração máxima do arquivo de vídeo OZ_VIDEO_DURATION_MAX = 30 ``` Para evitar sobrecarga no TFSS, agora é possível gerenciar o número de solicitações concorrentes que a API envia ao TFSS. Isso é feito por meio do `OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_MODE` parâmetro. Verifique as opções possíveis abaixo.
ValorDescriçãoParâmetros adicionais a definir
OFFPadrão; sem limites aplicados-
TOTAL Um limite compartilhado para todos os tipos de análise Defina o limite em OZ_SERVICE_TFSS_CONCURRENCY_LIMIT (padrão: 0)
SEPARATE Um limite para cada tipo de análise

Defina o limite para cada uma das análises:

  • OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_QUALITY,
  • OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_BIOMETRY,
  • OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_COLLECTION.
Ao exceder o limite, a API retorna HTTP `429 Too Many Requests`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://doc.ozforensics.com/oz-knowledge/oz-knowledge/pt-br/guias/administrator-guide/configuracao/configuration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.