github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-29 18:08:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

update golden-query notebook and fix typo in golden docs (#8253)

Browse Source 
updating the documentation to be consistent for Golden query tool and
have a better introduction to the tool
This commit is contained in:
Emory Petermann 2023-07-25 18:15:48 -07:00 committed by GitHub
parent c14571ab37
commit 7734a2b5ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 156 additions and 138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/extras/integrations/providers/golden.mdx
View File

@ -1,6 +1,6 @@
# Golden # Golden
>[Golden](https://golden.com) provides a set of natural language APIs for querying and enrichment using the Golden Knowledge Graph e.g. queries such as: `Products from OpenAI`, `Generative ai companies with series a funding`, and `rappers who invest` can be used to retrieve relevant structured data about relevant entities. >[Golden](https://golden.com) provides a set of natural language APIs for querying and enrichment using the Golden Knowledge Graph e.g. queries such as: `Products from OpenAI`, `Generative ai companies with series a funding`, and `rappers who invest` can be used to retrieve structured data about relevant entities.
> >
>The `golden-query` langchain tool is a wrapper on top of the [Golden Query API](https://docs.golden.com/reference/query-api) which enables programmatic access to these results. >The `golden-query` langchain tool is a wrapper on top of the [Golden Query API](https://docs.golden.com/reference/query-api) which enables programmatic access to these results.
>See the [Golden Query API docs](https://docs.golden.com/reference/query-api) for more information. >See the [Golden Query API docs](https://docs.golden.com/reference/query-api) for more information.

42
docs/extras/integrations/tools/golden_query.ipynb
View File

@ -1,26 +1,34 @@
{ {
"cells": [ "cells": [
{ {
"attachments": {},
"cell_type": "markdown", "cell_type": "markdown",
"id": "245a954a", "id": "245a954a",
"metadata": {}, "metadata": {
"id": "245a954a"
},
"source": [ "source": [
"# Golden Query\n", "# Golden Query\n",
"\n", "\n",
"This notebook goes over how to use the golden-query tool.\n", ">[Golden](https://golden.com) provides a set of natural language APIs for querying and enrichment using the Golden Knowledge Graph e.g. queries such as: `Products from OpenAI`, `Generative ai companies with series a funding`, and `rappers who invest` can be used to retrieve structured data about relevant entities.\n",
">\n",
">The `golden-query` langchain tool is a wrapper on top of the [Golden Query API](https://docs.golden.com/reference/query-api) which enables programmatic access to these results.\n",
">See the [Golden Query API docs](https://docs.golden.com/reference/query-api) for more information.\n",
"\n",
"\n",
"This notebook goes over how to use the `golden-query` tool.\n",
"\n", "\n",
"- Go to the [Golden API docs](https://docs.golden.com/) to get an overview about the Golden API.\n", "- Go to the [Golden API docs](https://docs.golden.com/) to get an overview about the Golden API.\n",
"- Create a Golden account if you don't have one on the [Golden Website](golden.com).\n",
"- Get your API key from the [Golden API Settings](https://golden.com/settings/api) page.\n", "- Get your API key from the [Golden API Settings](https://golden.com/settings/api) page.\n",
"- Save your API key into GOLDEN_API_KEY env variable" "- Save your API key into GOLDEN_API_KEY env variable"
] ]
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": 5, "execution_count": null,
"id": "34bb5968", "id": "34bb5968",
"metadata": {}, "metadata": {
"id": "34bb5968"
},
"outputs": [], "outputs": [],
"source": [ "source": [
"import os\n", "import os\n",
@ -30,9 +38,11 @@
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": 6, "execution_count": null,
"id": "ac4910f8", "id": "ac4910f8",
"metadata": {}, "metadata": {
"id": "ac4910f8"
},
"outputs": [], "outputs": [],
"source": [ "source": [
"from langchain.utilities.golden_query import GoldenQueryAPIWrapper" "from langchain.utilities.golden_query import GoldenQueryAPIWrapper"
@ -40,9 +50,11 @@
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": 7, "execution_count": null,
"id": "84b8f773", "id": "84b8f773",
"metadata": {}, "metadata": {
"id": "84b8f773"
},
"outputs": [], "outputs": [],
"source": [ "source": [
"golden_query = GoldenQueryAPIWrapper()" "golden_query = GoldenQueryAPIWrapper()"
@ -50,9 +62,12 @@
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": 9, "execution_count": null,
"id": "068991a6", "id": "068991a6",
"metadata": {}, "metadata": {
"id": "068991a6",
"outputId": "c5cdc6ec-03cf-4084-cc6f-6ae792d91d39"
},
"outputs": [ "outputs": [
{ {
"data": { "data": {
@ -135,6 +150,9 @@
"interpreter": { "interpreter": {
"hash": "53f3bc57609c7a84333bb558594977aa5b4026b1d6070b93987956689e367341" "hash": "53f3bc57609c7a84333bb558594977aa5b4026b1d6070b93987956689e367341"
} }
},
"colab": {
"provenance": []
} }
}, },
"nbformat": 4, "nbformat": 4,