Merge remote-tracking branch 'origin/main' into feat/validation-summary

Author: zsimjee

.dockerignore

@@ -0,0 +1,3 @@
+__pycache__
+*.pyc
+*.pyo

.github/workflows/install_from_hub.yml

@@ -9,6 +9,8 @@ on:
 jobs:
   install_from_hub:
     runs-on: ubuntu-latest
+    env:
+      GUARDRAILS_API_KEY: ${{ secrets.GUARDRAILS_API_KEY }}
     steps:
     - name: Set up Python
       uses: actions/setup-python@v5
@@ -17,6 +19,8 @@ jobs:
     - name: pip install from main
       run: pip install git+https://github.com/guardrails-ai/guardrails.git@main
     - name: Install PII validator
-      run: guardrails hub install hub://guardrails/detect_pii
+      run: |
+        guardrails configure --token $GUARDRAILS_API_KEY --disable-metrics --enable-remote-inferencing;
+        guardrails hub install hub://guardrails/detect_pii;
     - name: Verify PII validator is addressable
       run: echo 'from guardrails.hub import DetectPII' | python 

.github/workflows/server_ci.yml

@@ -0,0 +1,60 @@
+name: Server CI
+
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+
+jobs:
+    build-test-server:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out head
+              uses: actions/checkout@v3
+              with:
+                persist-credentials: false
+
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@master
+              with:
+                platforms: linux/amd64
+
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@master
+              with:
+                platforms: linux/amd64
+
+            - name: Build Docker image
+              uses: docker/build-push-action@v6
+              with:
+                context: .
+                file: server_ci/Dockerfile
+                platforms: linux/amd64
+                push: false
+                tags: guardrails:${{ github.sha }}
+                load: true
+                build-args: |
+                  GUARDRAILS_TOKEN=${{ secrets.GUARDRAILS_API_KEY }}
+
+            - name: Start Docker container
+              run: |
+                  docker run -d --name guardrails-container -p 8000:8000 -e OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY }} guardrails:${{ github.sha }}
+        
+            - name: Wait for Docker container to be ready
+              run: |
+                for i in {1..30}; do
+                if docker exec guardrails-container curl -s http://localhost:8000/; then
+                    echo "Server is up!"
+                    break
+                fi
+                echo "Waiting for server..."
+                sleep 5
+                done
+    
+            - name: Run Pytest
+              run: |
+                pip install pytest openai guardrails-ai
+                pytest server_ci/tests
+                docker stop guardrails-container
+                docker rm guardrails-container

README.md

@@ -147,7 +147,7 @@ prompt = """
 
     ${gr.complete_json_suffix_v2}
 """
-guard = Guard.from_pydantic(output_class=Pet, prompt=prompt)
+guard = Guard.for_pydantic(output_class=Pet, prompt=prompt)
 
 raw_output, validated_output, *rest = guard(
     llm_api=openai.completions.create,

docs/api_reference/async_guard.md

@@ -5,10 +5,10 @@
     options:
         members: 
             - "__init__"
-            - "from_rail"
-            - "from_rail_string"
-            - "from_pydantic"
-            - "from_string"
+            - "for_rail"
+            - "for_rail_string"
+            - "for_pydantic"
+            - "for_string"
             - "configure"
             - "use"
             - "use_many"

docs/api_reference/guard.md

@@ -5,10 +5,10 @@
     options:
         members: 
             - "__init__"
-            - "from_rail"
-            - "from_rail_string"
-            - "from_pydantic"
-            - "from_string"
+            - "for_rail"
+            - "for_rail_string"
+            - "for_pydantic"
+            - "for_string"
             - "configure"
             - "use"
             - "use_many"

docs/concepts/error_remediation.md

@@ -37,6 +37,8 @@ Guardrails provides a number of `OnFailActions` for when a validator fails. The
 | `OnFailAction.FIX_REASK` | First, fix the generated output deterministically, and then rerun validation with the deterministically fixed output. If validation fails, then perform reasking.           | No | 
 
 
+Custom OnFailActions can also be implemented, see the `custom` section in the [how to use on fail actions guide](../how_to_guides/use_on_fail_actions).
+
 ## Guidance on dealing with Validator errors
 
 When a validator fails, Guardrails does two things

docs/concepts/logs.md

@@ -9,7 +9,7 @@ Calls can be further decomposed into a stack of `Iteration` objects. These are s
 ## General Access
 Given:
 ```py
-my_guard = Guard.from_pydantic(...)
+my_guard = Guard.for_pydantic(...)
 
 response_1 = my_guard(...)