Totoy 0.0.6

Totoy .NET API library

The official C# library for the Totoy API.

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.

Example

using Totoy;
using Totoy.Models.Components;
using System.Collections.Generic;
using System;
using Totoy.Models.Errors;

var sdk = new TotoySDK(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");

ExplanationRequest req = new ExplanationRequest() {
    OutputLanguage = Totoy.Models.Components.OutputLanguage.En,
    SourceId = "<value>",
    Messages = new List<Message>() {
        new Message() {
            Role = Totoy.Models.Components.Role.User,
            Content = "<value>",
            References = new List<Reference>() {
                new Reference() {
                    Text = "[R1]",
                    SourceId = "{\"source-id-example\":{\"value\":\"src_dmZ7imKLaPcQnv5ckvGlOEAA7\"}}",
                    PageNumber = 5,
                    Backlink = "https://www.example.com/text.pdf",
                },
            },
        },
    },
};

try
{
    var res = await sdk.Explanation.CreateAsync(req);
    // handle response
}
catch (Exception ex)
{
    if (ex is Problem)
    {
        // handle exception
    }
    else if (ex is Totoy.Models.Errors.SDKException)
    {
        // handle exception
    }
}

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIndex: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverUrl: str optional parameter when initializing the SDK client instance. For example:

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the ApiKeyAuth parameter must be set when initializing the SDK client instance. For example:

using Totoy;
using Totoy.Models.Components;
using System.Collections.Generic;

var sdk = new TotoySDK(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");

ExplanationRequest req = new ExplanationRequest() {
    OutputLanguage = Totoy.Models.Components.OutputLanguage.En,
    SourceId = "<value>",
    Messages = new List<Message>() {
        new Message() {
            Role = Totoy.Models.Components.Role.User,
            Content = "<value>",
            References = new List<Reference>() {
                new Reference() {
                    Text = "[R1]",
                    SourceId = "{\"source-id-example\":{\"value\":\"src_dmZ7imKLaPcQnv5ckvGlOEAA7\"}}",
                    PageNumber = 5,
                    Backlink = "https://www.example.com/text.pdf",
                },
            },
        },
    },
};

var res = await sdk.Explanation.CreateAsync(req);

// handle response