Getting Started
Spaces Guide
Tools Guide
Developer Guide
API REFERENCE
- Spaces
- Data
- Chat
- Assistants
- Documents
PULZE ACADEMY
Rate Log By Id
Rate a specific request by its ID. When accessing it via an App’s API Key, this endpoint will only allow rating a log of that specific app.
POST
/
v1
/
logs
/
{log_id}
/
rating
Copy
Ask AI
curl --request POST \
--url https://api.pulze.ai/v1/logs/{log_id}/rating \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"good_answer": true,
"feedback": "<string>"
}'
Copy
Ask AI
{
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"good_answer": true,
"feedback": "<string>",
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0,
"prompt_tokens_cost": 0,
"completion_tokens_cost": 0,
"total_tokens_cost": 0,
"prompt_tokens_cost_savings": 0,
"completion_tokens_cost_savings": 0,
"total_tokens_cost_savings": 0,
"app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"auth0_id": "<string>",
"costs_incurred": true,
"namespace": "<string>",
"payload": {
"model": "<string>",
"max_tokens": 123,
"temperature": 0.5,
"top_p": 123,
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"tool_choice": "none",
"n": 2,
"stream": true,
"logprobs": 2,
"stop": "<string>",
"presence_penalty": 0,
"frequency_penalty": 0,
"best_of": 2,
"logit_bias": {},
"response_format": {
"type": "text"
},
"messages": [
{
"role": "user",
"content": "<string>",
"tool_calls": [
{
"function": {
"arguments": "<string>",
"name": "<string>"
},
"id": "<string>",
"type": "function"
}
]
}
],
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plugins": [
"legacy-file-search"
],
"images": [
"<string>"
],
"files": [
"<string>"
],
"custom_headers": {
"labels": {},
"headers": {},
"weights": {
"cost": 0,
"latency": 0,
"quality": 1
},
"policies": {
"privacy_level": 1,
"max_cost": 0.02,
"max_switch_model_retries": 1,
"max_same_model_retries": 1,
"optimize_internal_requests": 0,
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"feature_flags": {
"citations": false,
"auto_tools": false,
"smart_learn": true
}
}
},
"privacy_level": 1,
"prompt": "<string>",
"request_type": "completions",
"response_text": "<string>",
"response": {
"choices": [
{
"index": 123,
"finish_reason": "<string>",
"message": {
"role": "user",
"content": "<string>",
"tool_calls": [
{
"function": {
"arguments": "<string>",
"name": "<string>"
},
"id": "<string>",
"type": "function"
}
]
}
}
],
"created": 0,
"metadata": {
"app_id": "<string>",
"model": {
"model": "<string>",
"provider": "<string>",
"owner": "<string>",
"namespace": "<string>",
"at": "<string>"
},
"costs": {
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123
},
"cost_savings": {
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123
},
"generated_artifacts": {
"items": [
{}
]
},
"search_results": {
"items": [
{}
]
},
"latency": 123,
"labels": {},
"error": "<string>",
"scores": {
"best_models": [],
"candidates": [
{}
]
},
"score": 123,
"temperature": 123,
"max_tokens": 0,
"status_code": 123,
"retries": 0,
"extra": {},
"warning": "<string>"
},
"id": "<string>",
"usage": {
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123
},
"model": "<string>",
"object": "text_completion"
},
"status_code": -1,
"is_test": false,
"added_on": "2023-11-07T05:31:56Z",
"latency": -1,
"timestamp": 123,
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_saved_for_later": false,
"comment_count": 0,
"parent": {},
"children": [
{}
],
"model": {
"supports_functions": true,
"supports_json": true,
"supports_n": true,
"supports_penalties": true,
"supports_stream": true,
"supports_vision": true,
"completion_token_cost": 123,
"prompt_token_cost": 123,
"base_cost": 123,
"price_unit": "tokens",
"model": "<string>",
"provider": "<string>",
"owner": "<string>",
"namespace": "<string>",
"at": "<string>",
"context_window": 123,
"until": "2023-11-07T05:31:56Z",
"description": "<string>",
"url": "<string>",
"api_target": "",
"deprecated_on": "2023-11-07T05:31:56Z",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent": {},
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_rag": true,
"is_ft": true,
"is_open_source": true,
"is_gdpr": true,
"is_chat": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"added_by": "<string>",
"added_on": "2023-11-07T05:31:56Z",
"modified_on": "2023-11-07T05:31:56Z",
"is_public": true,
"is_test_model": true,
"is_pulze_owner": true,
"default_active": true
},
"collections": [
{
"name": "<string>",
"collection": {
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"request_count": 123
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request POST \
--url https://api.pulze.ai/v1/logs/{log_id}/rating \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"good_answer": true,
"feedback": "<string>"
}'
Copy
Ask AI
{
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"good_answer": true,
"feedback": "<string>",
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0,
"prompt_tokens_cost": 0,
"completion_tokens_cost": 0,
"total_tokens_cost": 0,
"prompt_tokens_cost_savings": 0,
"completion_tokens_cost_savings": 0,
"total_tokens_cost_savings": 0,
"app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"auth0_id": "<string>",
"costs_incurred": true,
"namespace": "<string>",
"payload": {
"model": "<string>",
"max_tokens": 123,
"temperature": 0.5,
"top_p": 123,
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"tool_choice": "none",
"n": 2,
"stream": true,
"logprobs": 2,
"stop": "<string>",
"presence_penalty": 0,
"frequency_penalty": 0,
"best_of": 2,
"logit_bias": {},
"response_format": {
"type": "text"
},
"messages": [
{
"role": "user",
"content": "<string>",
"tool_calls": [
{
"function": {
"arguments": "<string>",
"name": "<string>"
},
"id": "<string>",
"type": "function"
}
]
}
],
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plugins": [
"legacy-file-search"
],
"images": [
"<string>"
],
"files": [
"<string>"
],
"custom_headers": {
"labels": {},
"headers": {},
"weights": {
"cost": 0,
"latency": 0,
"quality": 1
},
"policies": {
"privacy_level": 1,
"max_cost": 0.02,
"max_switch_model_retries": 1,
"max_same_model_retries": 1,
"optimize_internal_requests": 0,
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"feature_flags": {
"citations": false,
"auto_tools": false,
"smart_learn": true
}
}
},
"privacy_level": 1,
"prompt": "<string>",
"request_type": "completions",
"response_text": "<string>",
"response": {
"choices": [
{
"index": 123,
"finish_reason": "<string>",
"message": {
"role": "user",
"content": "<string>",
"tool_calls": [
{
"function": {
"arguments": "<string>",
"name": "<string>"
},
"id": "<string>",
"type": "function"
}
]
}
}
],
"created": 0,
"metadata": {
"app_id": "<string>",
"model": {
"model": "<string>",
"provider": "<string>",
"owner": "<string>",
"namespace": "<string>",
"at": "<string>"
},
"costs": {
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123
},
"cost_savings": {
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123
},
"generated_artifacts": {
"items": [
{}
]
},
"search_results": {
"items": [
{}
]
},
"latency": 123,
"labels": {},
"error": "<string>",
"scores": {
"best_models": [],
"candidates": [
{}
]
},
"score": 123,
"temperature": 123,
"max_tokens": 0,
"status_code": 123,
"retries": 0,
"extra": {},
"warning": "<string>"
},
"id": "<string>",
"usage": {
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123
},
"model": "<string>",
"object": "text_completion"
},
"status_code": -1,
"is_test": false,
"added_on": "2023-11-07T05:31:56Z",
"latency": -1,
"timestamp": 123,
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_saved_for_later": false,
"comment_count": 0,
"parent": {},
"children": [
{}
],
"model": {
"supports_functions": true,
"supports_json": true,
"supports_n": true,
"supports_penalties": true,
"supports_stream": true,
"supports_vision": true,
"completion_token_cost": 123,
"prompt_token_cost": 123,
"base_cost": 123,
"price_unit": "tokens",
"model": "<string>",
"provider": "<string>",
"owner": "<string>",
"namespace": "<string>",
"at": "<string>",
"context_window": 123,
"until": "2023-11-07T05:31:56Z",
"description": "<string>",
"url": "<string>",
"api_target": "",
"deprecated_on": "2023-11-07T05:31:56Z",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent": {},
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_rag": true,
"is_ft": true,
"is_open_source": true,
"is_gdpr": true,
"is_chat": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"added_by": "<string>",
"added_on": "2023-11-07T05:31:56Z",
"modified_on": "2023-11-07T05:31:56Z",
"is_public": true,
"is_test_model": true,
"is_pulze_owner": true,
"default_active": true
},
"collections": [
{
"name": "<string>",
"collection": {
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"request_count": 123
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.