Aller au contenu principal

io.enterpriseai.model.ChatRequest

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/model/ChatRequest.java. Retour à l'index de la référence du SDK Java.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Modèle ChatRequest​

Corps de POST /v1/gateway/chat/completions (compatible OpenAI plus eai).

Champs :

NomTypeRequisDescription
modelStringouiAlias de modèle de la passerelle qui répond à la requête.
messagesList<ChatMessage>ouiMessages de la conversation, dans l'ordre.
temperatureDoubleouiTempérature d'échantillonnage, omise du JSON quand elle est null.
maxTokensIntegerouiNombre maximal de jetons de sortie ; s'il est fourni, c'est la sortie retenue pour le pire cas.
toolsList<Map<String, Object>>ouiOutils que ses agents externes peuvent invoquer (noms ou motifs comme crm.*).
streamBooleanouiVrai pour une réponse diffusée en flux SSE ; omis du JSON quand il est null.
eaiEaiExtensionouiLe champ de corps d'extension eai des appels à la passerelle.

ChatRequest.withStream​

ChatRequest withStream(boolean value)

Copie avec stream renseigné.

NomTypeDéfautRequisDescription
valuebooleanouiValeur de stream de la copie.

Retour : ChatRequest. Un nouveau ChatRequest identique avec stream remplacé.

Classe ChatRequest.Builder​

Constructeur fluide.

Builder.agent​

Builder agent(String agent, String session, String run, String task)

Fixe les identifiants d'agent, de session, de run et de tâche envoyés dans l'extension eai.

NomTypeDéfautRequisDescription
agentStringouiIdentifiant de l'agent (eai.agent_id), peut être null.
sessionStringouiIdentifiant de la session (eai.session_id), peut être null.
runStringouiIdentifiant du run (eai.run_id), peut être null.
taskStringouiIdentifiant de la tâche (eai.task_id), peut être null.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.assistant​

Builder assistant(String text)

Ajoute un message assistant.

NomTypeDéfautRequisDescription
textStringouiTexte du message de l'assistant.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.build​

ChatRequest build()

Construit la requête ; l'extension eai n'est renseignée que si au moins un de ses champs a été donné.

Cet élément ne prend aucun paramètre.

Retour : ChatRequest. Un ChatRequest : corps de POST /v1/gateway/chat/completions (compatible OpenAI plus eai), avec stream non renseigné.

Builder.dataClassification​

Builder dataClassification(String c)

Fixe eai.data_classification.

NomTypeDéfautRequisDescription
cStringouiClassification des données envoyées, par exemple confidential.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.effort​

Builder effort(Effort e)

Fixe l'effort de raisonnement normalisé eai.effort.

NomTypeDéfautRequisDescription
eEffortouiEffort demandé.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.fallbackPolicy​

Builder fallbackPolicy(String p)

Fixe eai.fallback_policy.

NomTypeDéfautRequisDescription
pStringouiPolitique de repli du routage de modèle.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.maxTokens​

Builder maxTokens(int n)

Fixe max_tokens.

NomTypeDéfautRequisDescription
nintouiNombre maximal de jetons à générer.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.message​

Builder message(ChatMessage m)

Ajoute un message déjà construit.

NomTypeDéfautRequisDescription
mChatMessageouiChatMessage à ajouter à messages.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.purpose​

Builder purpose(String p)

Fixe eai.purpose, la finalité du traitement.

NomTypeDéfautRequisDescription
pStringouiFinalité du traitement.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.regionAllow​

Builder regionAllow(List<String> regions)

Fixe eai.region_allow à partir d'une copie de la liste.

NomTypeDéfautRequisDescription
regionsList<String>ouiRégions de traitement autorisées pour le routage.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.system​

Builder system(String text)

Ajoute un message system.

NomTypeDéfautRequisDescription
textStringouiTexte du message système.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.temperature​

Builder temperature(double t)

Fixe la temperature d'échantillonnage.

NomTypeDéfautRequisDescription
tdoubleouiTempérature d'échantillonnage.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.tools​

Builder tools(List<Map<String, Object>> t)

Fixe les définitions tools compatibles OpenAI.

NomTypeDéfautRequisDescription
tList<Map<String, Object>>ouiDéfinitions d'outils, une table par outil.

Retour : Builder. Ce même Builder, pour enchaîner les appels.

Builder.user​

Builder user(String text)

Ajoute un message user.

NomTypeDéfautRequisDescription
textStringouiTexte du message de l'utilisateur.

Retour : Builder. Ce même Builder, pour enchaîner les appels.