Merge branch 'main' of https://github.com/wordlift/docs

wordlift · Apr 4, 2024 · e1feee2 · e1feee2
2 parents 859b9d3 + 91948ca
commit e1feee2
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 2 deletions.
diff --git a/api/manager.yaml b/api/manager.yaml
@@ -24,6 +24,8 @@ tags:
   name: AddOns
 - description: Data URI for a Web page URL.
   name: Data URI
+- description: Add embeddings to a Knowledge Graphs.
+  name: Embedding
 - description: Import sitemaps to the KG
   name: Sitemap Imports
 - description: Retrieve analytics data from Google Search Console
@@ -412,7 +414,9 @@ paths:
               schema:
                 type: array
                 items:
-                  type: string
+                  type: object
+                  additionalProperties:
+                    type: string
           description: Success
         "401":
           description: Authentication Failure
@@ -645,6 +649,34 @@ paths:
       summary: Create an Authorization URI
       tags:
       - Google Search Console OAuth2
+  /kg/embeddings:
+    post:
+      description: Create the embedding for the IRIs for the provided query.
+      operationId: createEmbedding
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/EmbeddingRequest'
+        required: true
+      responses:
+        "201":
+          content:
+            application/x-ndjson:
+              schema:
+                type: array
+                items:
+                  type: object
+                  additionalProperties:
+                    type: string
+          description: Success
+        "401":
+          description: Authentication Failure
+      security:
+      - ApiKey: []
+      summary: Create
+      tags:
+      - Embedding
   /merchants:
     get:
       description: "List the Merchants, optionally filtering by the `deleted` flag"
@@ -1507,6 +1539,16 @@ components:
       required:
       - dataset_domain
       - dataset_name
+    EmbeddingRequest:
+      type: object
+      properties:
+        graphql_query:
+          type: string
+        properties:
+          type: array
+          items:
+            type: string
+          uniqueItems: true
     ExchangeAuthCodeRequest:
       type: object
       description: The request of the `exchangeAuthCode` endpoint.

diff --git a/docs/agent-wordlift/getting-started.md b/docs/agent-wordlift/getting-started.md
@@ -45,4 +45,10 @@ Generate an outline for a new, informative article based on the combined insight
 
 ```md
 expand the content on https://wordlift.io/ by integrating entities like Google and Semantic Web.
-```
+```
+
+:::infoNote
+
+At the moment we are **not able to support Chinese language** for some of the Agent tasks that require analysing texts or queries.
+
+:::