.. AUTO-GENERATED FILE. DO NOT EDIT.

knowledge-bases-book-pages-embedding-manifests-get-one
======================================================

Source
------

- Repository: ``jef-systems/jef-knowledge-bases-backend``
- Source Run ID: ``25224728551``
- Source SHA: ``aa5ff95e9fc61b1117b4e8fbff26c3c0f37efea2``
- Module: ``knowledge-bases``
- Documentation Scope: ``get``
- Lambda: ``jef-knowledge-bases-get-7``

Endpoint
--------

- API Name: ``jef-knowledge-bases``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/knowledge-bases-book-pages-embedding-manifests-get-one``
- Complete Endpoint: ``https://in42anzkh6.execute-api.ap-southeast-1.amazonaws.com/prod/knowledge-bases-book-pages-embedding-manifests-get-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-knowledge-bases-get-7``
- curl payload mode: ``query_string``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-knowledge-bases-get-7
   API Name: jef-knowledge-bases
   Action: get
   Method: GET
   Resource Path: /knowledge-bases-book-pages-embedding-manifests-get-one
   
   Table:
   - table: jef-knowledge-bases-book-pages-embedding-manifests
   - operation: get-one
   
   Payload Schema:
   - pk: embedding_manifest_id
   
   Payload Example:
   - pk: embed-manifest-document-001-page-0001-v1
   
   Response Schema:
   - exists: boolean
   - message: string
   - item: {"embedding_manifest_id":"string","document_id":"string","page_id":"string","book_version":"string","knowledge_base_id":"string","book_id":"string","book_slug":"string","slug":"string","name":"string","title":"string","source_hash":"string","text_hash":"string","source_type":"string","source_uri":"string","s3_bucket":"string","s3_key":"string","content_type":"string","page_number":"number","page_number_padded":"string","page_label":"string","aws_region":"string","s3_vector_bucket_name":"string","s3_vector_index_name":"string","embedding_model":"string","embedding_dimensions":"number","chunk_count":"number","embedded_count":"number","written_count":"number","failed_batch_count":"number","chunk_size_chars":"number","chunk_overlap_chars":"number","embed_batch_size":"number","vector_put_batch_size":"number","workflow":"string","pipeline_run_id":"string","github_run_id":"string","manifest_uri":"string","manifest_hash":"string","preview_uri":"string","failed_batches_uri":"string","embedding_status":"string","status":"string","active":"boolean","completed":"boolean","failed":"boolean","started_at":"string","completed_at":"string","failed_at":"string","created_at":"string","updated_at":"string","error_message":"string","idempotency_key":"string"}

Request Payload
---------------

.. code-block:: json

   {
     "pk": "embedding_manifest_id"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"embedding_manifest_id\":\"string\",\"document_id\":\"string\",\"page_id\":\"string\",\"book_version\":\"string\",\"knowledge_base_id\":\"string\",\"book_id\":\"string\",\"book_slug\":\"string\",\"slug\":\"string\",\"name\":\"string\",\"title\":\"string\",\"source_hash\":\"string\",\"text_hash\":\"string\",\"source_type\":\"string\",\"source_uri\":\"string\",\"s3_bucket\":\"string\",\"s3_key\":\"string\",\"content_type\":\"string\",\"page_number\":\"number\",\"page_number_padded\":\"string\",\"page_label\":\"string\",\"aws_region\":\"string\",\"s3_vector_bucket_name\":\"string\",\"s3_vector_index_name\":\"string\",\"embedding_model\":\"string\",\"embedding_dimensions\":\"number\",\"chunk_count\":\"number\",\"embedded_count\":\"number\",\"written_count\":\"number\",\"failed_batch_count\":\"number\",\"chunk_size_chars\":\"number\",\"chunk_overlap_chars\":\"number\",\"embed_batch_size\":\"number\",\"vector_put_batch_size\":\"number\",\"workflow\":\"string\",\"pipeline_run_id\":\"string\",\"github_run_id\":\"string\",\"manifest_uri\":\"string\",\"manifest_hash\":\"string\",\"preview_uri\":\"string\",\"failed_batches_uri\":\"string\",\"embedding_status\":\"string\",\"status\":\"string\",\"active\":\"boolean\",\"completed\":\"boolean\",\"failed\":\"boolean\",\"started_at\":\"string\",\"completed_at\":\"string\",\"failed_at\":\"string\",\"created_at\":\"string\",\"updated_at\":\"string\",\"error_message\":\"string\",\"idempotency_key\":\"string\"}"
   }

CMD curl
--------

.. code-block:: text

   curl "https://in42anzkh6.execute-api.ap-southeast-1.amazonaws.com/prod/knowledge-bases-book-pages-embedding-manifests-get-one?pk=embed-manifest-document-001-page-0001-v1"

PowerShell curl
---------------

.. code-block:: text

   curl.exe "https://in42anzkh6.execute-api.ap-southeast-1.amazonaws.com/prod/knowledge-bases-book-pages-embedding-manifests-get-one?pk=embed-manifest-document-001-page-0001-v1"