Ingestion de documents directement dans une base de connaissances

Vous pouvez définir les types de documents suivants en ligne :

Si vous ingérez un document depuis un emplacement S3, l'DocumentContentobjet du content champ doit être de la forme suivante :

{ 
    "custom": { 
        "customDocumentIdentifier": { 
            "id": "string"
        },
        "s3Location": { 
            "bucketOwnerAccountId": "string",
            "uri": "string"
        },
        "sourceType": "S3"
    },
    "dataSourceType": "CUSTOM"
}

Incluez l’ID du document dans le champ id, le propriétaire du compartiment S3 qui contient le document dans le champ bucketOwnerAccountId et l’URI S3 du document dans le champ uri.

Si vous définissez les métadonnées en ligne, l'DocumentMetadataobjet du metadata champ doit être au format suivant :

{ 
    "inlineAttributes": [ 
        { 
            "key": "string",
            "value": { 
                "stringValue": "string",
                "booleanValue": boolean,
                "numberValue": number,
                "stringListValue": [ "string" ],
                "type": "STRING" | "BOOLEAN" | "NUMBER" | "STRING_LIST"
            }
        }
    ],
    "type": "IN_LINE_ATTRIBUTE"
}

Pour chaque attribut que vous ajoutez, définissez la clé dans le champ key. Spécifiez le type de données de la valeur dans le champ type et incluez le champ correspondant au type de données. Par exemple, si vous incluez une chaîne, l’attribut sera au format suivant :

{ 
    "key": "string",
    "value": { 
        "stringValue": "string",
        "type": "STRING"
    }
}

Vous pouvez également ingérer les métadonnées d’un fichier portant l’extension .metadata.json dans un emplacement S3. Pour plus d’informations sur le format d’un fichier de métadonnées, consultez la section Champs de métadonnées des documents dans Connexion à Amazon S3 pour votre base de connaissances.

Si les métadonnées proviennent d'un fichier S3, l'DocumentMetadataobjet du metadata champ doit être au format suivant :

{
    "s3Location": { 
        "bucketOwnerAccountId": "string",
        "uri": "string"
    },
        "type": "S3_LOCATION"
    }
 }

Incluez le propriétaire du compartiment S3 qui contient le fichier de métadonnées dans le champ bucketOwnerAccountId, ainsi que l’URI S3 du fichier de métadonnées dans le champ uri.

L’exemple suivant montre l’ajout d’un document texte à une source de données personnalisée :

PUT /knowledgebases/KB12345678/datasources/DS12345678/documents HTTP/1.1
Content-type: application/json

{
   "documents": [ 
      { 
         "content": { 
            "dataSourceType": "CUSTOM",
            "custom": { 
               "customDocumentIdentifier": { 
                  "id": "MyDocument"
               },
               "inlineContent": { 
                  "textContent": { 
                     "data": "Hello world!"
                  },
                  "type": "TEXT"
               },
               "sourceType": "IN_LINE"
            }
         }
     }
   ]
}

L’exemple suivant montre l’ajout d’un document PDF à une source de données personnalisée :

PUT /knowledgebases/KB12345678/datasources/DS12345678/documents HTTP/1.1
Content-type: application/json

{
   "documents": [ 
      { 
         "content": { 
            "dataSourceType": "CUSTOM",
            "custom": { 
               "customDocumentIdentifier": { 
                  "id": "MyDocument"
               },
               "inlineContent": { 
                  "byteContent": { 
                     "data": "<Base64-encoded string>",
                     "mimeType": "application/pdf"
                  },
                  "type": "BYTE"
               },
               "sourceType": "IN_LINE"
            }
         }
     }
   ]
}

L’exemple suivant montre l’ajout, depuis un emplacement S3, d’un document texte à une source de données personnalisée :

PUT /knowledgebases/KB12345678/datasources/DS12345678/documents HTTP/1.1
Content-type: application/json

{
   "documents": [ 
      { 
         "content": { 
            "dataSourceType": "CUSTOM",
            "custom": { 
               "customDocumentIdentifier": { 
                  "id": "MyDocument"
               },
               "s3": {
                "s3Location": {
                    "uri": "amzn-s3-demo-bucket"
                }
               },
               "sourceType": "S3"
            }
         }
     }
   ]
}

L’exemple suivant montre l’ajout en ligne d’un document à une source de données personnalisée avec des métadonnées contenant deux attributs :

PUT /knowledgebases/KB12345678/datasources/DS12345678/documents HTTP/1.1
Content-type: application/json

{
   "documents": [ 
      { 
         "content": { 
            "dataSourceType": "CUSTOM",
            "custom": { 
               "customDocumentIdentifier": { 
                  "id": "MyDocument"
               },
               "inlineContent": { 
                  "textContent": { 
                     "data": "Hello world!"
                  },
                  "type": "TEXT"
               },
               "sourceType": "IN_LINE"
            }
         },
         "metadata": {
            "inlineAttributes": [ 
               { 
                  "key": "genre",
                  "value": {
                     "stringValue": "pop",
                     "type": "STRING"
                  }
               },
               { 
                  "key": "year",
                  "value": { 
                     "numberValue": 1988,
                     "type": "NUMBER"
                  }
               }
            ],
            "type": "IN_LINE_ATTRIBUTE"
         }
     }
   ]
}

L’exemple suivant montre l’ajout d’un document et de métadonnées à une source de données S3. Vous ne pouvez inclure les métadonnées que via S3 :

PUT /knowledgebases/KB12345678/datasources/DS12345678/documents HTTP/1.1
Content-type: application/json

{
    "documents": [ 
        { 
            "content": { 
                "dataSourceType": "S3",
                "s3": { 
                "s3Location": {
                    "uri": "amzn-s3-demo-bucket"
                }
            }
        },
        "metadata": {
            "s3Location": {
                "bucketOwnerId": "111122223333",
                "uri": "amzn-s3-demo-bucket"
            },
                "type": "S3_LOCATION"
            }
        }
    ]
}