Visão geralServiçosEventosRecursos
TermoAI

Config system gateway

7 funções do TermoAI para config system gateway.

// npm install termo_core --save-exact
import * as ai from "termo_core/ai";
// ou: import { ai } from "termo_core";
FunçãoRotaO que faz
buscar_paginador_config_system_gatewayGET /config_system_gatewayLista as regras do gateway paginadas
criar_config_system_gatewayPOST /config_system_gatewayCadastra as regras do gateway de uma categoria
buscar_auto_complete_config_system_gatewayGET /config_system_gateway/autocompleteLista básica das regras do gateway para seleção
buscar_pelo_filtro_config_system_gatewayGET /config_system_gateway/filtroBusca as regras do gateway por categoria
buscar_pelo_id_config_system_gatewayGET /config_system_gateway/{id}Busca as regras do gateway pelo id
atualizar_pelo_id_config_system_gatewayPATCH /config_system_gateway/{id}Atualiza as regras do gateway pelo id
deletar_pelo_id_config_system_gatewayDELETE /config_system_gateway/{id}Exclui as regras do gateway pelo id

buscar_paginador_config_system_gateway

GET/config_system_gateway Exige credencial

Lista as regras do gateway paginadas

Exige qualquer permissão da área configuracoes (qualquer ação liberada na área já libera a leitura). Lista as configurações não excluídas na ordem de cadastro. pagina começa em 1 (padrão 1) e tamanho tem padrão 10, sem máximo; valores menores que 1 viram 1. total é a quantidade de configurações não excluídas.

function buscar_paginador_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorConfigSystemGateway = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaConfigSystemGateway>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_config_system_gateway(credencial_de_acesso, { pagina: 1 });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaConfigSystemGateway> · Rust: Result<tipos::PaginaConfigSystemGateway, ErroAoChamarServico> · veja PaginaConfigSystemGateway.

criar_config_system_gateway

POST/config_system_gateway Exige credencial

Cadastra as regras do gateway de uma categoria

Exige a permissão criar da área configuracoes. Define como POST /gateway atende uma categoria: tempo_limite_segundos por tentativa (5 a 600), prazo_total_segundos do pedido (5 a 1800, maior ou igual ao tempo por tentativa), maximo_tentativas (1 a 50) e quanto tempo uma chave fica pausada depois de uma falha comum (espera_falha_segundos, 0 a 86400), de estourar o limite por minuto (espera_limite_segundos, 1 a 86400), de esgotar a cota diária (espera_cota_diaria_segundos, 1 a 86400) e de ter a chave recusada (espera_chave_invalida_segundos, 1 a 86400). categoria é obrigatória (texto_para_texto, imagem_para_texto, texto_para_imagem, audio_para_texto, texto_para_audio, video_para_texto ou texto_para_video) e só pode ter uma configuração; campo não enviado assume o padrão da categoria. Sem configuração, o gateway usa os padrões.

function criar_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.ConfigSystemGatewayCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.ConfigSystemGateway>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { criar_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_config_system_gateway(credencial_de_acesso, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.ConfigSystemGateway> · Rust: Result<tipos::ConfigSystemGateway, ErroAoChamarServico> · veja ConfigSystemGateway.

buscar_auto_complete_config_system_gateway

GET/config_system_gateway/autocomplete Exige credencial

Lista básica das regras do gateway para seleção

Exige qualquer permissão da área configuracoes (qualquer ação liberada na área já libera a leitura). Devolve só id e categoria, em ordem alfabética da categoria, sem as excluídas. busca procura o trecho no nome da categoria. pagina começa em 1 (padrão 1) e tamanho tem padrão 10.

function buscar_auto_complete_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteConfigSystemGateway = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaConfigSystemGatewayAutoComplete>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_config_system_gateway(credencial_de_acesso, { busca: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaConfigSystemGatewayAutoComplete> · Rust: Result<tipos::PaginaConfigSystemGatewayAutoComplete, ErroAoChamarServico> · veja PaginaConfigSystemGatewayAutoComplete.

buscar_pelo_filtro_config_system_gateway

GET/config_system_gateway/filtro Exige credencial

Busca as regras do gateway por categoria

Exige qualquer permissão da área configuracoes (qualquer ação liberada na área já libera a leitura). Devolve as configurações não excluídas, sem paginação, na ordem de cadastro. categoria precisa ser igual ao nome da categoria (por exemplo texto_para_texto); sem filtro, devolve todas.

function buscar_pelo_filtro_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroConfigSystemGateway = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.ConfigSystemGateway>>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_config_system_gateway(credencial_de_acesso, { categoria: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<Array<tipos.ConfigSystemGateway>> · Rust: Result<Vec<tipos::ConfigSystemGateway>, ErroAoChamarServico>

buscar_pelo_id_config_system_gateway

GET/config_system_gateway/{id} Exige credencial

Busca as regras do gateway pelo id

Exige qualquer permissão da área configuracoes (qualquer ação liberada na área já libera a leitura). Devolve a configuração do gateway de uma categoria, com os tempos em segundos. Configuração excluída não é encontrada.

function buscar_pelo_id_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.ConfigSystemGateway>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_config_system_gateway(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.ConfigSystemGateway> · Rust: Result<tipos::ConfigSystemGateway, ErroAoChamarServico> · veja ConfigSystemGateway.

atualizar_pelo_id_config_system_gateway

PATCH/config_system_gateway/{id} Exige credencial

Atualiza as regras do gateway pelo id

Exige a permissão editar da área configuracoes. Atualização parcial: só os tempos enviados mudam, nas mesmas faixas do cadastro, e o prazo total continua maior ou igual ao tempo por tentativa. A categoria não muda.

function atualizar_pelo_id_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.ConfigSystemGatewayAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.ConfigSystemGateway>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_config_system_gateway(credencial_de_acesso, id, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.ConfigSystemGateway> · Rust: Result<tipos::ConfigSystemGateway, ErroAoChamarServico> · veja ConfigSystemGateway.

deletar_pelo_id_config_system_gateway

DELETE/config_system_gateway/{id} Exige credencial

Exclui as regras do gateway pelo id

Exige a permissão deletar da área configuracoes. Exclusão lógica: a categoria volta a usar as regras padrão do gateway e pode ganhar uma configuração nova. Excluir de novo responde 404.

function deletar_pelo_id_config_system_gateway(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_config_system_gateway } from "termo_core/ai";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_config_system_gateway(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

ConfigSystemGateway

import type { ConfigSystemGateway } from "termo_core/ai";

export interface ConfigSystemGateway {
  atualizado_em: string;
  categoria: string;
  criado_em: string;
  espera_chave_invalida_segundos: number;
  espera_cota_diaria_segundos: number;
  espera_falha_segundos: number;
  espera_limite_segundos: number;
  id: string;
  maximo_tentativas: number;
  prazo_total_segundos: number;
  tempo_limite_segundos: number;
}

ConfigSystemGatewayAtualizar

import type { ConfigSystemGatewayAtualizar } from "termo_core/ai";

export type ConfigSystemGatewayAtualizar = ValoresDoGateway;

ConfigSystemGatewayCriar

import type { ConfigSystemGatewayCriar } from "termo_core/ai";

export type ConfigSystemGatewayCriar = ValoresDoGateway & ConfigSystemGatewayCriarParte2;

ConfigSystemGatewayCriarParte2

import type { ConfigSystemGatewayCriarParte2 } from "termo_core/ai";

export interface ConfigSystemGatewayCriarParte2 {
  categoria: string;
}

PaginaConfigSystemGateway

import type { PaginaConfigSystemGateway } from "termo_core/ai";

export interface PaginaConfigSystemGateway {
  itens: Array<PaginaConfigSystemGatewayItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaConfigSystemGatewayAutoComplete

import type { PaginaConfigSystemGatewayAutoComplete } from "termo_core/ai";

export interface PaginaConfigSystemGatewayAutoComplete {
  itens: Array<PaginaConfigSystemGatewayAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaConfigSystemGatewayAutoCompleteItensItem

import type { PaginaConfigSystemGatewayAutoCompleteItensItem } from "termo_core/ai";

export interface PaginaConfigSystemGatewayAutoCompleteItensItem {
  categoria: string;
  id: string;
}

PaginaConfigSystemGatewayItensItem

import type { PaginaConfigSystemGatewayItensItem } from "termo_core/ai";

export interface PaginaConfigSystemGatewayItensItem {
  atualizado_em: string;
  categoria: string;
  criado_em: string;
  espera_chave_invalida_segundos: number;
  espera_cota_diaria_segundos: number;
  espera_falha_segundos: number;
  espera_limite_segundos: number;
  id: string;
  maximo_tentativas: number;
  prazo_total_segundos: number;
  tempo_limite_segundos: number;
}

ValoresDoGateway

import type { ValoresDoGateway } from "termo_core/ai";

export interface ValoresDoGateway {
  espera_chave_invalida_segundos?: number | null;
  espera_cota_diaria_segundos?: number | null;
  espera_falha_segundos?: number | null;
  espera_limite_segundos?: number | null;
  maximo_tentativas?: number | null;
  prazo_total_segundos?: number | null;
  tempo_limite_segundos?: number | null;
}

Colaborador

5 funções do TermoAI para colaborador.

Configuração

2 funções do TermoAI para configuração.

Nesta página

buscar_paginador_config_system_gatewaycriar_config_system_gatewaybuscar_auto_complete_config_system_gatewaybuscar_pelo_filtro_config_system_gatewaybuscar_pelo_id_config_system_gatewayatualizar_pelo_id_config_system_gatewaydeletar_pelo_id_config_system_gatewayTiposConfigSystemGatewayConfigSystemGatewayAtualizarConfigSystemGatewayCriarConfigSystemGatewayCriarParte2PaginaConfigSystemGatewayPaginaConfigSystemGatewayAutoCompletePaginaConfigSystemGatewayAutoCompleteItensItemPaginaConfigSystemGatewayItensItemValoresDoGateway