Skip to content

README.md

Latest commit

 

History

History
199 lines (129 loc) · 12.8 KB

README.md

File metadata and controls

199 lines (129 loc) · 12.8 KB
Raw

Feedback

Overview

Available Operations

remove_evaluation

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.feedback.remove_evaluation()

    # Use the SDK ...

Parameters

Parameter Type Required Description
request models.PostV2FeedbackEvaluationRemoveRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

create_evaluation

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.feedback.create_evaluation()

    # Use the SDK ...

Parameters

Parameter Type Required Description
request models.PostV2FeedbackEvaluationRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

remove

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.feedback.remove()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.PostV2FeedbackRemoveRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostV2FeedbackRemoveResponseBody

Errors

Error Type Status Code Content Type
models.PostV2FeedbackRemoveFeedbackResponseBody 404 application/json
models.APIDefaultError 4XX, 5XX */*

create

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.feedback.create()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.PostV2FeedbackRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostV2FeedbackResponseBody

Errors

Error Type Status Code Content Type
models.PostV2FeedbackFeedbackResponseBody 400 application/json
models.PostV2FeedbackFeedbackResponseResponseBody 404 application/json
models.APIDefaultError 4XX, 5XX */*

submit

Report problems or request features for Orq.ai APIs, MCP tools, SDKs, and documentation.

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.feedback.submit(message="<value>", category="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
message str ✔️ What happened, what was expected, and steps to reproduce. Do not include secrets.
category str ✔️ N/A
request_id Optional[str] ➖ N/A
url Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SubmitFeedbackResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*