В этом руководстве приведены примеры использования основных функций API базы знаний для разработчиков: поиск документов, получение одного документа и получение нескольких документов одновременно.
Прежде чем начать, убедитесь, что вы включили API и сгенерировали ключ API для разработчиков , а также сохраните свой ключ в переменной среды:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Поиск документов с помощью SearchDocumentChunks
Используйте метод documents.searchDocumentChunks для поиска фрагментов документа, соответствующих заданной строке запроса. Результаты включают фрагменты содержимого документа и ссылку на parent элемент, которую можно использовать для получения полного содержимого документа.
В следующем примере выполняется поиск документов, соответствующих запросу "BigQuery":
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
Вы можете уточнить результаты поиска, используя такие параметры, как pageSize , чтобы ограничить количество результатов на странице, и pageToken чтобы получить доступ к последующим страницам.
Получите документ с помощью GetDocument
Для получения полного содержимого отдельного документа используйте метод documents.get SearchDocumentChunks DocumentChunk.parent
В следующем примере извлекается документ с именем documents/DOCUMENT_ID :
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
В ответе вы получите полный Document , включая поле content .
Получение нескольких документов одновременно с помощью BatchGetDocuments
Используйте метод documents.batchGet для получения до 100 документов по имени за один вызов API. Это эффективнее, чем выполнение нескольких запросов GetDocument .
В следующем примере извлекаются два документа по имени:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
В ответе содержится список запрошенных ресурсов Document .