chore(fix): Fix broken links in Readme and mypy fixes in the test files (#21)

* chore: release 0.1.0

Release-As: 0.1.0

* chore(fix):Fix broken links in Readme + mypy fixes in the test files

* chore(fix):fix lint errors

* chore(fix): fix mypy on google.cloud.spanner

* chore(update): Addressing PR comments

* chore(fix): remove unnecessary variable

Author: shreya6goel

.github/header-checker-lint.yml

@@ -36,6 +36,5 @@ ignoreFiles:
   - '.github/header-checker-lint.yml'
   - '.github/sync-repo-settings.yaml'
   - '.github/workflows/docs.yml'
-  - '.kokoro/**'
   - '**/requirements.txt'
   - '**/requirements-test.txt' 

.github/trusted-contribution.yml

@@ -28,5 +28,5 @@ annotations:
   - type: comment
     text: "/gcbrun"
   # Trigger Kokoro example
-  # - type: label
-  #   text: "kokoro:force-run"
+  - type: label
+    text: "kokoro:force-run"

.github/workflows/lint.yml

@@ -52,5 +52,5 @@ jobs:
           black --check .
           isort --check .
 
-      # - name: Run type-check
-      #   run: mypy --install-types --non-interactive .
+      - name: Run type-check
+        run: mypy --install-types --non-interactive .

DEVELOPER.md

@@ -30,7 +30,7 @@ Learn more by reading [How should I write my commits?](https://github.com/google
 
 ### CI Platform Setup
 
-Cloud Build is used to run tests against Google Cloud resources in test project: langchain-spanner-testing.
+Cloud Build is used to run tests against Google Cloud resources in test project: llamaindex-spanner-testing.
 Each test has a corresponding Cloud Build trigger, see [all triggers][triggers].
 These tests are registered as required tests in `.github/sync-repo-settings.yaml`.
 
@@ -43,7 +43,7 @@ name: integration-test-pr-py39
 description: Run integration tests on PR for Python 3.9
 filename: integration.cloudbuild.yaml
 github:
-  name: langchain-google-spanner-python
+  name: llama-index-spanner-python
   owner: googleapis
   pullRequest:
     branch: .*
@@ -54,9 +54,9 @@ ignoredFiles:
   - .github/**
   - "*.md"
 substitutions:
-  _INSTANCE_ID: <ADD_VALUE>
-  _PG_DATABASE: <ADD_VALUE>
-  _GOOGLE_DATABASE: <ADD_VALUE>
+  _SPANNER_INSTANCE_ID: <ADD_VALUE>
+  _SPANNER_DATABASE_ID: <ADD_VALUE>
+  _SPANNER_GRAPH_NAME: <ADD_VALUE>
   _VERSION: "3.9"
 ```
 
@@ -72,7 +72,7 @@ Use `gcloud builds triggers import --source=trigger.yaml` to create triggers via
 * Run integration test:
 
     ```bash
-    gcloud builds submit --config integration.cloudbuild.yaml --region us-central1 --substitutions=_INSTANCE_ID=$INSTANCE_ID
+    gcloud builds submit --config integration.cloudbuild.yaml --region us-central1 --substitutions=_SPANNER_INSTANCE_ID=$_SPANNER_INSTANCE_ID
     ```
 
 #### Trigger
@@ -92,4 +92,4 @@ Here is a breakdown of the report:
 - `Missing`: lines that are not covered by tests.
 
 
-[triggers]: https://console.cloud.google.com/cloud-build/triggers?e=13802955&project=langchain-spanner-testing
+[triggers]: https://console.cloud.google.com/cloud-build/triggers?e=13802955&project=llamaindex-spanner-testing

README.md

@@ -111,8 +111,9 @@ retriever = SpannerGraphCustomRetriever(
     similarity_top_k=4,
     path_depth=2,
     graph_store=graph_store,
-    llm=llm,
+    llm_text_to_gql=llm,
     embed_model=embed_model,
+    llmranker_top_n=3,
 )
 retriever.retriever("Who lives in desert?")
 ```
@@ -123,12 +124,12 @@ See the full [Spanner Graph Retrievers](https://github.com/googleapis/llama-inde
 
 Contributions to this library are always welcome and highly encouraged.
 
-See [CONTRIBUTING](CONTRIBUTING.md) for more information how to get started.
+See [CONTRIBUTING](https://github.com/googleapis/llama-index-spanner-python/blob/main/CONTRIBUTING.md) for more information how to get started.
 
 Please note that this project is released with a Contributor Code of Conduct. By participating in
-this project you agree to abide by its terms. See [Code of Conduct](CODE_OF_CONDUCT.md) for more
+this project you agree to abide by its terms. See [Code of Conduct](https://github.com/googleapis/llama-index-spanner-python/blob/main/CODE_OF_CONDUCT.md) for more
 information.
 
 ## License
 
-Apache 2.0 - See [LICENSE](LICENSE) for more information.
+Apache 2.0 - See [LICENSE](https://github.com/googleapis/llama-index-spanner-python/blob/main/LICENSE) for more information.

src/llama_index_spanner/graph_retriever.py

@@ -79,10 +79,10 @@ def __init__(
         llm: Optional[LLM] = None,
         text_to_gql_prompt: Optional[PromptTemplate] = None,
         gql_validator: Optional[Callable[[str], bool]] = None,
-        include_raw_response_as_metadata: Optional[bool] = False,
-        max_gql_fix_retries: Optional[int] = 1,
-        verify_gql: Optional[bool] = True,
-        summarize_response: Optional[bool] = False,
+        include_raw_response_as_metadata: bool = False,
+        max_gql_fix_retries: int = 1,
+        verify_gql: bool = True,
+        summarize_response: bool = False,
         summarization_template: Optional[Union[PromptTemplate, str]] = None,
         **kwargs,
     ) -> None:
@@ -132,7 +132,9 @@ def __init__(
 
     def _validate_generated_gql(self, gql_query: str) -> str:
         if self.gql_validator is not None:
-            return self.gql_validator(gql_query)
+            is_valid = self.gql_validator(gql_query)
+            if not is_valid:
+                raise ValueError(f"Generated GQL is not valid: {gql_query}")
         return gql_query
 
     def execute_query(self, gql_query: str) -> List[Any]:
@@ -277,10 +279,10 @@ def init(
         llm_text_to_gql: Optional[LLM] = None,
         text_to_gql_prompt: Optional[PromptTemplate] = None,
         gql_validator: Optional[Callable[[str], bool]] = None,
-        include_raw_response_as_metadata: Optional[bool] = False,
-        max_gql_fix_retries: Optional[int] = 1,
-        verify_gql: Optional[bool] = True,
-        summarize_response: Optional[bool] = False,
+        include_raw_response_as_metadata: bool = False,
+        max_gql_fix_retries: int = 1,
+        verify_gql: bool = True,
+        summarize_response: bool = False,
         summarization_template: Optional[Union[PromptTemplate, str]] = None,
         ## LLM reranker params
         llm_for_reranker: Optional[LLM] = None,