CarbonMarketsHQ GPT
CarbonMarketsHQ GPT · Actions GPT
FastAPI
POST /rag/searchSearchPOST /vcm/projects/listList ProjectsPOST /vcm/projects/aggregationsAggregate ProjectsPOST /vcm/analyticsAnalytics
Schéma original API
{
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"servers": [
{
"url": "https://api.carbonmarketshq.com",
"description": "CarbonMarketsHQ Server"
}
],
"paths": {
"/rag/search": {
"post": {
"summary": "Search",
"operationId": "search_rag_search_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/vcm/projects/list": {
"post": {
"summary": "List Projects",
"operationId": "list_projects_vcm_projects_list_post",
"security": [
{
"APIKeyHeader": []
}
],
"parameters": [
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Skip"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 100,
"title": "Limit"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectListSearchCriteria"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectModel"
},
"title": "Response List Projects Vcm Projects List Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/vcm/projects/aggregations": {
"post": {
"summary": "Aggregate Projects",
"operationId": "aggregate_projects_vcm_projects_aggregations_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregationSearchCriteria"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GroupedProjectModel"
},
"type": "array",
"title": "Response Aggregate Projects Vcm Projects Aggregations Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"APIKeyHeader": []
}
]
}
},
"/vcm/analytics": {
"post": {
"summary": "Analytics",
"operationId": "analytics_vcm_analytics_post",
"parameters": [
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "Authorization"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AggregatedFieldModel": {
"properties": {
"sum": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Sum"
},
"avg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Avg"
},
"min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Max"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Count"
}
},
"type": "object",
"title": "AggregatedFieldModel"
},
"AggregationSearchCriteria": {
"properties": {
"general_filters": {
"$ref": "#/components/schemas/GeneralFilters"
},
"range_filters": {
"$ref": "#/components/schemas/RangeFilters"
},
"group_by": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"example": [
"voluntary_registry"
]
},
"aggregate_functions": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Aggregate Functions",
"example": {
"total_credits_issued": "sum"
}
},
"order_by": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Order By",
"example": [
"total_credits_issued_sum"
]
},
"order_direction": {
"type": "string",
"title": "Order Direction",
"default": "asc",
"example": "desc"
}
},
"type": "object",
"title": "AggregationSearchCriteria",
"example": {
"aggregate_functions": {
"total_credits_issued": "sum"
},
"general_filters": {
"project_id": [
"GS2940",
"ACR102"
],
"voluntary_registry": [
"ACR"
]
},
"group_by": [
"voluntary_registry"
],
"order_by": [
"total_credits_issued_sum"
],
"order_direction": "asc",
"range_filters": {
"total_credits_issued": {
"max": 500000,
"min": 10000
}
}
}
},
"AnalyticsRequest": {
"properties": {
"start_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date"
},
"end_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date"
}
},
"type": "object",
"title": "AnalyticsRequest"
},
"AnalyticsResponse": {
"properties": {
"credits_summary_ytd": {
"$ref": "#/components/schemas/CreditsSummaryYTD"
},
"credits_over_time": {
"items": {
"$ref": "#/components/schemas/YearlyCredits"
},
"type": "array",
"title": "Credits Over Time"
},
"country_data": {
"items": {
"$ref": "#/components/schemas/CountryData"
},
"type": "array",
"title": "Country Data"
},
"registry_data": {
"items": {
"$ref": "#/components/schemas/RegistryData"
},
"type": "array",
"title": "Registry Data"
},
"projects_credits_by_scope": {
"items": {
"$ref": "#/components/schemas/ScopeTypeData"
},
"type": "array",
"title": "Projects Credits By Scope"
},
"projects_credits_by_type": {
"items": {
"$ref": "#/components/schemas/ScopeTypeData"
},
"type": "array",
"title": "Projects Credits By Type"
}
},
"type": "object",
"required": [
"credits_summary_ytd",
"credits_over_time",
"country_data",
"registry_data",
"projects_credits_by_scope",
"projects_credits_by_type"
],
"title": "AnalyticsResponse"
},
"Answer": {
"properties": {
"highlights": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Highlights"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
}
},
"type": "object",
"title": "Answer"
},
"Caption": {
"properties": {
"highlights": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Highlights"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text"
}
},
"type": "object",
"title": "Caption"
},
"CountryData": {
"properties": {
"country": {
"type": "string",
"title": "Country"
},
"projects_count": {
"type": "integer",
"title": "Projects Count"
},
"total_credits_issued": {
"type": "integer",
"title": "Total Credits Issued"
}
},
"type": "object",
"required": [
"country",
"projects_count",
"total_credits_issued"
],
"title": "CountryData"
},
"CreditDataModel": {
"properties": {
"project_id": {
"type": "string",
"title": "Project Id"
},
"year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Year"
},
"credits_issued": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Credits Issued"
},
"credits_retired": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Credits Retired"
},
"credits_remaining": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Credits Remaining"
},
"credits_registry": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Credits Registry"
}
},
"type": "object",
"required": [
"project_id"
],
"title": "CreditDataModel"
},
"CreditsSummaryYTD": {
"properties": {
"issued": {
"type": "integer",
"title": "Issued"
},
"retired": {
"type": "integer",
"title": "Retired"
},
"remaining": {
"type": "integer",
"title": "Remaining"
},
"buffer_pool_deposit": {
"type": "integer",
"title": "Buffer Pool Deposit"
}
},
"type": "object",
"required": [
"issued",
"retired",
"remaining",
"buffer_pool_deposit"
],
"title": "CreditsSummaryYTD"
},
"DateRange": {
"properties": {
"start": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Start"
},
"end": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "End"
}
},
"type": "object",
"title": "DateRange"
},
"ExtractTextRequest": {
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"perform_chunking": {
"type": "boolean",
"title": "Perform Chunking",
"default": false
}
},
"type": "object",
"required": [
"url"
],
"title": "ExtractTextRequest"
},
"ExtractTextResponse": {
"properties": {
"extracted_texts": {
"items": {
"$ref": "#/components/schemas/ExtractedText"
},
"type": "array",
"title": "Extracted Texts"
}
},
"type": "object",
"required": [
"extracted_texts"
],
"title": "ExtractTextResponse"
},
"ExtractedText": {
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"index": {
"type": "integer",
"title": "Index"
},
"text": {
"type": "string",
"title": "Text"
}
},
"type": "object",
"required": [
"url",
"index",
"text"
],
"title": "ExtractedText"
},
"GeneralFilters": {
"properties": {
"project_id": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Id"
},
"project_name": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Name"
},
"voluntary_registry": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Voluntary Registry"
},
"arb_project": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Arb Project"
},
"voluntary_status": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Voluntary Status"
},
"scope": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Scope"
},
"type": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Type"
},
"reduction_removal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Reduction Removal"
},
"methodology_protocol": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Methodology Protocol"
},
"region": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Region"
},
"country": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Country"
},
"state": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "State"
},
"project_site_location": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Site Location"
},
"project_developer": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Developer"
},
"project_owner": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Owner"
},
"offset_project_operator": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Offset Project Operator"
},
"authorized_project_designee": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Authorized Project Designee"
},
"verifier": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Verifier"
},
"registry_arb": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Registry Arb"
},
"arb_project_detail": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Arb Project Detail"
},
"arbid": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Arbid"
},
"ccb_certifications": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ccb Certifications"
},
"project_type": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Type"
},
"registry_documents": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Registry Documents"
},
"project_website": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Project Website"
},
"notes_from_registry": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Notes From Registry"
},
"notes_from_cmhq": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Notes From Cmhq"
}
},
"type": "object",
"title": "GeneralFilters"
},
"GroupedProjectModel": {
"properties": {
"voluntary_registry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voluntary Registry"
},
"arb_project": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Arb Project"
},
"voluntary_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voluntary Status"
},
"scope": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Scope"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
},
"reduction_removal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reduction Removal"
},
"methodology_protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Methodology Protocol"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State"
},
"verifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Verifier"
},
"registry_arb": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Arb"
},
"ccb_certifications": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ccb Certifications"
},
"project_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Type"
},
"aggregated_fields": {
"anyOf": [
{
"additionalProperties": {
"$ref": "#/components/schemas/AggregatedFieldModel"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Aggregated Fields"
}
},
"type": "object",
"title": "GroupedProjectModel"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"NumericRange": {
"properties": {
"min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max"
}
},
"type": "object",
"title": "NumericRange"
},
"ProjectListSearchCriteria": {
"properties": {
"general_filters": {
"$ref": "#/components/schemas/GeneralFilters"
},
"range_filters": {
"$ref": "#/components/schemas/RangeFilters"
},
"order_by": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Order By",
"example": [
"project_name"
]
},
"order_direction": {
"type": "string",
"title": "Order Direction",
"default": "asc",
"example": "desc"
},
"include_credits": {
"type": "boolean",
"title": "Include Credits",
"default": false,
"example": true
}
},
"type": "object",
"title": "ProjectListSearchCriteria",
"example": {
"general_filters": {
"project_id": [
"GS2940",
"ACR102"
],
"project_listed": {
"end": "01/06/22",
"start": "01/01/22"
},
"project_name": [
"Project X"
]
},
"order_by": [
"project_name"
],
"order_direction": "asc",
"range_filters": {
"total_credits_issued": {
"max": 500000,
"min": 1000
},
"total_credits_retired": {
"max": 30000,
"min": 500
}
}
}
},
"ProjectModel": {
"properties": {
"project_id": {
"type": "string",
"title": "Project Id"
},
"project_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Name"
},
"voluntary_registry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voluntary Registry"
},
"arb_project": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Arb Project"
},
"voluntary_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Voluntary Status"
},
"scope": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Scope"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
},
"reduction_removal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reduction Removal"
},
"methodology_protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Methodology Protocol"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State"
},
"project_site_location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Site Location"
},
"project_developer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Developer"
},
"total_credits_issued": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Credits Issued"
},
"total_credits_retired": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Credits Retired"
},
"total_credits_remaining": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Credits Remaining"
},
"total_buffer_pool_deposits": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Buffer Pool Deposits"
},
"reversals_covered_by_buffer_pool": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Reversals Covered By Buffer Pool"
},
"reversals_not_covered_by_buffer": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Reversals Not Covered By Buffer"
},
"first_year_of_project": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "First Year Of Project"
},
"project_owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Owner"
},
"offset_project_operator": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Offset Project Operator"
},
"authorized_project_designee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorized Project Designee"
},
"verifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Verifier"
},
"estimated_annual_emission_reductions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Estimated Annual Emission Reductions"
},
"pers": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pers"
},
"registry_arb": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Arb"
},
"arb_project_detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Arb Project Detail"
},
"arbid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Arbid"
},
"project_listed": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Project Listed"
},
"project_registered": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Project Registered"
},
"ccb_certifications": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ccb Certifications"
},
"project_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Type"
},
"registry_documents": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Documents"
},
"project_website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Website"
},
"notes_from_registry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes From Registry"
},
"notes_from_cmhq": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes From Cmhq"
},
"first_issuance_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "First Issuance Year"
},
"credits": {
"items": {
"$ref": "#/components/schemas/CreditDataModel"
},
"type": "array",
"title": "Credits",
"default": []
}
},
"type": "object",
"required": [
"project_id"
],
"title": "ProjectModel"
},
"RangeFilters": {
"properties": {
"total_credits_issued": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"total_credits_retired": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"total_credits_remaining": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"total_buffer_pool_deposits": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"reversals_covered_by_buffer_pool": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"reversals_not_covered_by_buffer": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"first_year_of_project": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"estimated_annual_emission_reductions": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"pers": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
},
"project_listed": {
"anyOf": [
{
"$ref": "#/components/schemas/DateRange"
},
{
"type": "null"
}
]
},
"project_registered": {
"anyOf": [
{
"$ref": "#/components/schemas/DateRange"
},
{
"type": "null"
}
]
},
"first_issuance_year": {
"anyOf": [
{
"$ref": "#/components/schemas/NumericRange"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "RangeFilters"
},
"RegistryData": {
"properties": {
"registry": {
"type": "string",
"title": "Registry"
},
"projects_count": {
"type": "integer",
"title": "Projects Count"
},
"total_credits_issued": {
"type": "integer",
"title": "Total Credits Issued"
}
},
"type": "object",
"required": [
"registry",
"projects_count",
"total_credits_issued"
],
"title": "RegistryData"
},
"ScopeTypeData": {
"properties": {
"scope_type": {
"type": "string",
"title": "Scope Type"
},
"projects_count": {
"type": "integer",
"title": "Projects Count"
},
"total_credits_issued": {
"type": "integer",
"title": "Total Credits Issued"
}
},
"type": "object",
"required": [
"scope_type",
"projects_count",
"total_credits_issued"
],
"title": "ScopeTypeData"
},
"SearchRequest": {
"properties": {
"query": {
"type": "string",
"title": "Query"
}
},
"type": "object",
"required": [
"query"
],
"title": "SearchRequest"
},
"SearchResponse": {
"properties": {
"semantic_answers": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Answer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Semantic Answers"
},
"vector_results": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/VectorResult"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Vector Results"
}
},
"type": "object",
"title": "SearchResponse"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"VectorResult": {
"properties": {
"title": {
"type": "string",
"title": "Title"
},
"score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Score"
},
"reranker_score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reranker Score"
},
"captions": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Caption"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Captions"
},
"chunk": {
"type": "string",
"title": "Chunk"
}
},
"type": "object",
"required": [
"title",
"chunk"
],
"title": "VectorResult"
},
"YearlyCredits": {
"properties": {
"year": {
"type": "integer",
"title": "Year"
},
"credits": {
"type": "integer",
"title": "Credits"
}
},
"type": "object",
"required": [
"year",
"credits"
],
"title": "YearlyCredits"
}
},
"securitySchemes": {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY"
}
}
}
}