objectiveai-sdk 2.0.5

ObjectiveAI SDK, definitions, and utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! Request types for function listing endpoints.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Query parameters for the list functions endpoint.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "functions.ListFunctionsRequest")]
pub struct ListFunctionsRequest {
    /// Optional source filter for listing functions.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub source: Option<ListFunctionsSource>,
}

/// Source filter for listing functions.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "functions.ListFunctionsSource")]
#[serde(rename_all = "snake_case")]
pub enum ListFunctionsSource {
    All,
    Mock,
    Filesystem,
    Objectiveai,
}

impl ListFunctionsSource {
    pub fn as_str(&self) -> &str {
        match self {
            ListFunctionsSource::All => "all",
            ListFunctionsSource::Mock => "mock",
            ListFunctionsSource::Filesystem => "filesystem",
            ListFunctionsSource::Objectiveai => "objectiveai",
        }
    }
}

/// Query parameters for the list function-profile pairs endpoint.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "functions.ListFunctionProfilePairsRequest")]
pub struct ListFunctionProfilePairsRequest {
    /// Optional source filter for listing function-profile pairs.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schemars(extend("omitempty" = true))]
    pub source: Option<ListFunctionProfilePairsSource>,
}

/// Source filter for listing function-profile pairs.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "functions.ListFunctionProfilePairsSource")]
#[serde(rename_all = "snake_case")]
pub enum ListFunctionProfilePairsSource {
    Objectiveai,
}

/// Request parameters for getting a specific function.
pub type GetFunctionRequest = crate::RemotePathCommitOptional;

/// Request parameters for getting usage of a specific function-profile pair.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "functions.GetFunctionProfilePairUsageRequest")]
pub struct GetFunctionProfilePairUsageRequest {
    /// The function path.
    pub function: crate::RemotePathCommitOptional,
    /// The profile path.
    pub profile: crate::RemotePathCommitOptional,
}

impl ListFunctionProfilePairsSource {
    pub fn as_str(&self) -> &str {
        match self {
            ListFunctionProfilePairsSource::Objectiveai => "objectiveai",
        }
    }
}