Lingara Lingara Documentação Guias API Bibliotecas Aplicações Criar Incorporar Aplicação web
Idioma: Português

Diálogo com NPC

Esta página é uma tradução do inglês. Se as duas diferirem, a página em inglês é a correta. Ler a página em inglês

Uma personagem do seu jogo pode manter uma conversa com o jogador na língua que ele está a aprender, ajustada ao seu nível. Cada fala do jogador é um turno: o kit de jogador envia-a e a resposta da personagem chega em streaming, aos bocados.

O que um turno transporta

Cada turno envia tudo aquilo de que a personagem precisa, porque o Lingara não guarda nenhuma conversa entre turnos:

  • npc: quem está a falar. O seu name tem de 1 a 32 caracteres, e a sua persona opcional é uma linha de descrição, de 1 a 120 caracteres, como “um vendedor de dumplings”.
  • scene: opcional, onde decorre a conversa, de 1 a 160 caracteres.
  • source_lang e target_lang: a língua do próprio jogador e a que ele está a aprender. Têm de ser diferentes, e a personagem fala apenas target_lang.
  • level: o nível do jogador, de 1 a 9. O guia do Lingara “O que significa um nível” descreve a escala.
  • line: o que o jogador acabou de dizer, de 1 a 500 caracteres.
  • history: a conversa até ao momento, da mais antiga para a mais recente, no máximo 12 linhas. Cada linha tem um speaker, player ou npc, e o seu text, de 1 a 500 caracteres.

Cada texto é uma única linha. É o seu jogo que mantém a conversa: o kit de jogador guarda a janela de cada diálogo que abre, acrescenta-lhe cada turno terminado, corta cada resposta nos seus primeiros 500 caracteres e descarta as linhas mais antigas para além de 12.

O Lingara trata a persona e a cena como texto não fidedigno vindo do seu jogo. Moldam a forma como a personagem fala, nunca aquilo que lhe é permitido fazer.

Como chega uma resposta

A resposta chega em streaming como bocados de texto, que o seu jogo acrescenta à medida que chegam. Entre eles pode surgir um aviso, como um que indique que a resposta foi interrompida. O turno termina com done quando a resposta está completa, ou com error quando falhou. Um turno não pode ser retomado: se a ligação cair, o jogador volta a dizer a fala.

Diga uma fala de cada vez a cada personagem. Uma fala dita enquanto a personagem ainda está a responder é recusada em vez de ficar em fila, porque cada turno é faturado.

Quem paga

Só os jogadores de um cliente com faturação por utilização podem manter uma conversa, e cada turno é faturado a esse cliente. O token de um jogador precisa de embed:play.

Linguagem do exemplo de código

Bevy

fn spawn_seller(mut commands: Commands) {
    let mei = NpcDialogue::new("Mei", "zh", 2)
        .and_then(|npc| npc.with_persona("a dumpling seller"))
        .and_then(|npc| npc.with_scene("the night market"))
        .expect("within Lingara's bounds");
    commands.spawn(mei);
    commands.spawn(Player);
}

/// One turn at a time: a line said while the NPC is replying is a `Busy` error.
fn talk(keys: Res<ButtonInput<KeyCode>>, npcs: Query<Entity, With<NpcDialogue>>, mut say: MessageWriter<NpcSay>) {
    if keys.just_pressed(KeyCode::Digit1) {
        for entity in &npcs {
            say.write(NpcSay { entity, line: "饺子多少钱?".into() });
        }
    }
}

/// `streaming` grows as the reply arrives; `turns` holds the finished ones.
fn show_reply(transcripts: Query<&NpcTranscript, Changed<NpcTranscript>>) {
    for transcript in &transcripts {
        if let Some(partial) = &transcript.streaming {
            info!("…{partial}");
        }
    }
}

Unity

public DialogueId OpenDialogue(string npc, string sourceLang, string targetLang, byte level) =>
    Client.DialogueOpen(new DialogueConfig { Npc = new Npc { Name = npc }, SourceLang = sourceLang, TargetLang = targetLang, Level = level });

// The reply streams back as NpcTurn events: append each Fragment's text to your label.
public RequestId Say(DialogueId dialogue, string line) => Client.DialogueSay(dialogue, line);

Godot C#

public long OpenDialogue(string npc, string sourceLang, string targetLang, byte level) =>
    Client.DialogueOpen(new DialogueConfig { Npc = new Npc { Name = npc }, SourceLang = sourceLang, TargetLang = targetLang, Level = level }).Value;

// The reply streams back as NpcTurnFragment signals, then one NpcTurnFinished.
public long Say(long dialogue, string line) => Client.DialogueSay(new DialogueId(dialogue), line).Value;

GDScript

# A LingaraNpc child per character: npc_name, target_lang and level in the
# inspector. say() returns false while a turn is in flight (turns are never
# queued, because each one is billed).
func talk_to_mei(line: String) -> void:
	if mei.say(line):
		bubble.text = "…"


func _on_mei_replied(text: String) -> void:
	bubble.text = text

Unreal C++

void ALingaraEmbedSnippetActor::Say(const FString& Line)
{
	ELingaraCallResult Result;
	FLingaraEmbedError Error;
	if (Dialogue == 0)
	{
		FLingaraDialogueConfig Config;
		Config.Npc.Name = TEXT("Mei");
		Config.Npc.Persona = TEXT("a tea seller at the night market");
		Config.SourceLang = TEXT("en");
		Config.TargetLang = TEXT("zh");
		Config.Level = 2;
		Dialogue = Lingara()->DialogueOpen(Config, Result, Error);
	}
	Reply.Reset();
	Lingara()->DialogueSay(Dialogue, Line, Result, Error);
}

// The reply streams back as npc_turn events: append each fragment.
void ALingaraEmbedSnippetActor::HandleNpcTurn(const FLingaraNpcTurn& Turn)
{
	if (Turn.Dialogue == Dialogue && Turn.Update.Type == ELingaraNpcTurnUpdateType::Fragment)
	{
		Reply += Turn.Update.Text;
	}
}

Kotlin

fun talkToMei(line: String) {
    val dialogue = npc ?: lingara.dialogueOpen(DialogueConfig(Npc("Mei", "a tea seller"), "the tea house", "en", "zh", 2, emptyList()))
    npc = dialogue
    lingara.dialogueSay(dialogue, line)
}

private fun onNpcTurn(update: NpcTurnUpdate) {
    when (update) {
        is NpcTurnUpdate.Opened -> bubble = ""
        is NpcTurnUpdate.Fragment -> bubble += update.text
        is NpcTurnUpdate.Finished -> bubble = update.text
        else -> Unit
    }
}

Java

void talkToMei(String line) {
  if (npc < 0) {
    Npc mei = new Npc("Mei", "a tea seller");
    npc =
        lingara.dialogueOpen(new DialogueConfig(mei, "the tea house", "en", "zh", 2, List.of()));
  }
  lingara.dialogueSay(npc, line);
}

void onNpcTurn(EmbedEvent.NpcTurn turn) {
  if (turn.getUpdate() instanceof NpcTurnUpdate.Fragment fragment) {
    bubble.append(fragment.getText());
  } else if (turn.getUpdate() instanceof NpcTurnUpdate.Finished finished) {
    bubble.setLength(0);
    bubble.append(finished.getText());
  }
}

Ver também