robotframework-gemini 0.2.0__tar.gz → 0.3.0__tar.gz

{robotframework_gemini-0.2.0 → robotframework_gemini-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-gemini
-Version: 0.2.0
+Version: 0.3.0
 Summary: Google Gemini oracles for Robot Framework: text-only and multimodal (image) assertions.
 Project-URL: Homepage, https://github.com/carlosnizolli/robotframework-gemini
 Project-URL: Documentation, https://github.com/carlosnizolli/robotframework-gemini#readme
@@ -72,24 +72,26 @@ python -m pip install -e ".[dev]"
 from pathlib import Path
 from robotframework_gemini import GeminiOrchestrator
 
-orc = GeminiOrchestrator()
-ctx = "Web dashboard with the 'Active' category filter applied."
-crit = "Do the visible list items match the selected category?"
-raw = orc.evaluate_with_image(ctx, crit, Path("screen.png"))
+orchestrator = GeminiOrchestrator()
+context = "Web dashboard with the 'Active' category filter applied."
+evaluation = "Do the visible list items match the selected category?"
+model_response = orchestrator.evaluate_with_image(context, evaluation, Path("screen.png"))
 ```
 
 Para formato de saída restrito (ex.: Yes/No), use `extra_instructions`:
 
 ```python
-raw = orc.evaluate_with_text(
-    ctx,
-    crit,
+model_response = orchestrator.evaluate_with_text(
+    context,
+    evaluation,
     extra_instructions="Reply with one word only: Yes or No.",
 )
 ```
 
 ## Uso no Robot Framework
 
+> **Nota:** os exemplos usam `Set Variable` e `Catenate` em vez da keyword `VAR` (Robot Framework 7.0+) para manter retrocompatibilidade com versões anteriores do Robot Framework.
+
 ### Só texto (sem Browser)
 
 ```robot
@@ -98,10 +100,10 @@ Library    GeminiLibrary
 
 *** Keywords ***
 Validar resposta da API
-    ${ctx}=       Set Variable    {"status": "ok", "items": 3}
-    ${crit}=      Set Variable    O payload indica sucesso com itens?
-    ${raw}=       Gemini Evaluate Text    ${ctx}    ${crit}
-    Log    ${raw}
+    ${context}=       Set Variable    {"status": "ok", "items": 3}
+    ${evaluation}=    Set Variable    O payload indica sucesso com itens?
+    ${model_response}=    Gemini Evaluate Text    ${context}    ${evaluation}
+    Log    ${model_response}
 ```
 
 ### Com captura de tela (Browser)
@@ -115,10 +117,10 @@ Library    GeminiLibrary
 
 *** Keywords ***
 Checar tela por critério neutro
-    ${ctx}=       Set Variable    Lista filtrada por status Ativo.
-    ${crit}=      Set Variable    Todos os itens visíveis mostram status Ativo?
-    ${raw}=       Gemini Evaluate With Screen    ${ctx}    ${crit}
-    Log    ${raw}
+    ${context}=       Set Variable    Lista filtrada por status Ativo.
+    ${evaluation}=    Set Variable    Todos os itens visíveis mostram status Ativo?
+    ${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
+    Log    ${model_response}
 ```
 
 Import explícito (equivalente):
@@ -131,21 +133,26 @@ Com arquivo já salvo:
 
 ```robot
 Browser.Take Screenshot    ${OUTPUT_DIR}/tela.png
-${raw}=    Gemini Evaluate With Image File    ${ctx}    ${crit}    ${OUTPUT_DIR}/tela.png
+${model_response}=    Gemini Evaluate With Image File    ${context}    ${evaluation}    ${OUTPUT_DIR}/tela.png
 ```
 
 Veredito via prompt (primeira linha) e nota 1–5:
 
 ```robot
-${raw}=    Gemini Evaluate With Screen    ${ctx}    ${crit}
+${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
 ...    extra_instructions=Responda com uma palavra na primeira linha: Sim ou Não.
-${v}=    Get Line    ${raw}    0
-Should Be Equal As Strings    ${v}    Sim
+${verdict}=    Get Line    ${model_response}    0
+Should Be Equal As Strings    ${verdict}    Sim
+
+# Nota 1–5: duas etapas (log da justificativa) ou atalho em uma linha
+${model_response}=    Gemini Evaluate Text Rating    ${context}    ${evaluation}
+${rating_score}=    Gemini Parse Rating    ${model_response}
 
-${raw}=    Gemini Evaluate Text Rating    ${ctx}    ${criterion}
-${score}=    Gemini Parse Rating    ${raw}
+${rating_score}=    Gemini Evaluate Text Rating Score    ${context}    ${evaluation}
 ```
 
+Detalhes das três keywords de nota: [`docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar`](docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar).
+
 Consulte também [`examples/demo_template.robot`](examples/demo_template.robot).
 
 ## Documentação de Keywords

{robotframework_gemini-0.2.0 → robotframework_gemini-0.3.0}/README.md

@@ -38,24 +38,26 @@ python -m pip install -e ".[dev]"
 from pathlib import Path
 from robotframework_gemini import GeminiOrchestrator
 
-orc = GeminiOrchestrator()
-ctx = "Web dashboard with the 'Active' category filter applied."
-crit = "Do the visible list items match the selected category?"
-raw = orc.evaluate_with_image(ctx, crit, Path("screen.png"))
+orchestrator = GeminiOrchestrator()
+context = "Web dashboard with the 'Active' category filter applied."
+evaluation = "Do the visible list items match the selected category?"
+model_response = orchestrator.evaluate_with_image(context, evaluation, Path("screen.png"))
 ```
 
 Para formato de saída restrito (ex.: Yes/No), use `extra_instructions`:
 
 ```python
-raw = orc.evaluate_with_text(
-    ctx,
-    crit,
+model_response = orchestrator.evaluate_with_text(
+    context,
+    evaluation,
     extra_instructions="Reply with one word only: Yes or No.",
 )
 ```
 
 ## Uso no Robot Framework
 
+> **Nota:** os exemplos usam `Set Variable` e `Catenate` em vez da keyword `VAR` (Robot Framework 7.0+) para manter retrocompatibilidade com versões anteriores do Robot Framework.
+
 ### Só texto (sem Browser)
 
 ```robot
@@ -64,10 +66,10 @@ Library    GeminiLibrary
 
 *** Keywords ***
 Validar resposta da API
-    ${ctx}=       Set Variable    {"status": "ok", "items": 3}
-    ${crit}=      Set Variable    O payload indica sucesso com itens?
-    ${raw}=       Gemini Evaluate Text    ${ctx}    ${crit}
-    Log    ${raw}
+    ${context}=       Set Variable    {"status": "ok", "items": 3}
+    ${evaluation}=    Set Variable    O payload indica sucesso com itens?
+    ${model_response}=    Gemini Evaluate Text    ${context}    ${evaluation}
+    Log    ${model_response}
 ```
 
 ### Com captura de tela (Browser)
@@ -81,10 +83,10 @@ Library    GeminiLibrary
 
 *** Keywords ***
 Checar tela por critério neutro
-    ${ctx}=       Set Variable    Lista filtrada por status Ativo.
-    ${crit}=      Set Variable    Todos os itens visíveis mostram status Ativo?
-    ${raw}=       Gemini Evaluate With Screen    ${ctx}    ${crit}
-    Log    ${raw}
+    ${context}=       Set Variable    Lista filtrada por status Ativo.
+    ${evaluation}=    Set Variable    Todos os itens visíveis mostram status Ativo?
+    ${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
+    Log    ${model_response}
 ```
 
 Import explícito (equivalente):
@@ -97,21 +99,26 @@ Com arquivo já salvo:
 
 ```robot
 Browser.Take Screenshot    ${OUTPUT_DIR}/tela.png
-${raw}=    Gemini Evaluate With Image File    ${ctx}    ${crit}    ${OUTPUT_DIR}/tela.png
+${model_response}=    Gemini Evaluate With Image File    ${context}    ${evaluation}    ${OUTPUT_DIR}/tela.png
 ```
 
 Veredito via prompt (primeira linha) e nota 1–5:
 
 ```robot
-${raw}=    Gemini Evaluate With Screen    ${ctx}    ${crit}
+${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
 ...    extra_instructions=Responda com uma palavra na primeira linha: Sim ou Não.
-${v}=    Get Line    ${raw}    0
-Should Be Equal As Strings    ${v}    Sim
+${verdict}=    Get Line    ${model_response}    0
+Should Be Equal As Strings    ${verdict}    Sim
+
+# Nota 1–5: duas etapas (log da justificativa) ou atalho em uma linha
+${model_response}=    Gemini Evaluate Text Rating    ${context}    ${evaluation}
+${rating_score}=    Gemini Parse Rating    ${model_response}
 
-${raw}=    Gemini Evaluate Text Rating    ${ctx}    ${criterion}
-${score}=    Gemini Parse Rating    ${raw}
+${rating_score}=    Gemini Evaluate Text Rating Score    ${context}    ${evaluation}
 ```
 
+Detalhes das três keywords de nota: [`docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar`](docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar).
+
 Consulte também [`examples/demo_template.robot`](examples/demo_template.robot).
 
 ## Documentação de Keywords

{robotframework_gemini-0.2.0 → robotframework_gemini-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "robotframework-gemini"
-version = "0.2.0"
+version = "0.3.0"
 description = "Google Gemini oracles for Robot Framework: text-only and multimodal (image) assertions."
 readme = "README.md"
 requires-python = ">=3.10"

{robotframework_gemini-0.2.0 → robotframework_gemini-0.3.0}/src/robotframework_gemini/__init__.py

@@ -18,4 +18,4 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"

{robotframework_gemini-0.2.0 → robotframework_gemini-0.3.0}/src/robotframework_gemini/library.py

@@ -162,7 +162,8 @@ class GeminiLibrary:
 
         ``context`` — any test evidence (API body, logs, UI text, file excerpt, etc.).
         ``evaluation`` — criterion to score (how well the evidence meets the test intent).
-        Use ``Gemini Parse Rating`` to extract the integer score (1–5).
+        Returns raw model text (``SCORE:`` + ``REASON:``). Use ``Gemini Parse Rating`` to extract
+        the integer, or ``Gemini Evaluate Text Rating Score`` for a one-step score only.
         ``extra_instructions`` is appended after the built-in rubric.
         """
         return self._get_orchestrator().evaluate_with_text_rating(
@@ -173,9 +174,32 @@ class GeminiLibrary:
 
     @keyword("Gemini Parse Rating")
     def gemini_parse_rating(self, raw_response: str) -> str:
-        """Extract score 1–5 from a judge response; returns raw text if parsing fails."""
+        """Extract score 1–5 from a judge response; returns raw text if parsing fails.
+
+        Local parsing only (no API call). Works on output from ``Gemini Evaluate Text Rating``
+        or any text that follows ``SCORE:``/``NOTA:`` format.
+        """
         return GeminiOrchestrator.parse_rating(raw_response)
 
+    @keyword("Gemini Evaluate Text Rating Score")
+    def gemini_evaluate_text_rating_score(
+        self,
+        context: str,
+        evaluation: str,
+        extra_instructions: str | None = None,
+    ) -> str:
+        """Convenience: ``Gemini Evaluate Text Rating`` + ``Gemini Parse Rating`` in one call.
+
+        Returns only the integer score ``1``–``5`` as text. Prefer the two-step flow when you
+        need to log or assert on the full ``SCORE``/``REASON`` response from the model.
+        """
+        model_response = self.gemini_evaluate_text_rating(
+            context,
+            evaluation,
+            extra_instructions=extra_instructions,
+        )
+        return self.gemini_parse_rating(model_response)
+
     @keyword("Gemini Generate From Prompt")
     def gemini_generate_from_prompt(self, prompt: str) -> str:
         """Send a single text prompt and return the model reply (no context/evaluation template)."""