README.md

Suggest

(Suggest)

Overview

REST APIs for managing LLM OAS suggestions

Available Operations

• Suggest - Generate suggestions for improving an OpenAPI document.
• SuggestItems - Generate generic suggestions for a list of items.
• SuggestOpenAPI - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
• SuggestOpenAPIRegistry - Generate suggestions for improving an OpenAPI document stored in the registry.

Suggest

Get suggestions from an LLM model for improving an OpenAPI document.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;
using System.Collections.Generic;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

SuggestRequest req = new SuggestRequest() {
    SuggestRequestBody = new SuggestRequestBody() {
        Diagnostics = new List<Diagnostic>() {
            new Diagnostic() {
                Message = "<value>",
                Path = new List<string>() {
                    "/rescue",
                },
                Type = "<value>",
            },
        },
        OasSummary = new OASSummary() {
            Info = new OASInfo() {
                Description = "kielbasa psst stitcher cannon devoted blindly apropos low",
                License = new License() {},
                Summary = "<value>",
                Title = "<value>",
                Version = "<value>",
            },
            Operations = new List<OASOperation>() {
                new OASOperation() {
                    Description = "via apparatus gray whether opposite what",
                    Method = "<value>",
                    OperationId = "<id>",
                    Path = "/sys",
                    Tags = new List<string>() {
                        "<value>",
                    },
                },
            },
        },
        SuggestionType = SuggestRequestBodySuggestionType.MethodNames,
    },
    XSessionId = "<id>",
};

var res = await sdk.Suggest.SuggestAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	SuggestRequest	✔️	The request object to use for the request.

Response

SuggestResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*

SuggestItems

Generate generic suggestions for a list of items.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;
using System.Collections.Generic;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

SuggestItemsRequestBody req = new SuggestItemsRequestBody() {
    Items = new List<string>() {
        "<value>",
    },
    Prompt = "<value>",
};

var res = await sdk.Suggest.SuggestItemsAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	SuggestItemsRequestBody	✔️	The request object to use for the request.

Response

SuggestItemsResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*

SuggestOpenAPI

Get suggestions from an LLM model for improving an OpenAPI document.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;
using System;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

SuggestOpenAPIRequest req = new SuggestOpenAPIRequest() {
    RequestBody = new SuggestOpenAPIRequestBody() {
        Schema = new Schema() {
            Content = System.Text.Encoding.UTF8.GetBytes("0x0beEcB7cF6"),
            FileName = "example.file",
        },
    },
    XSessionId = "<id>",
};

var res = await sdk.Suggest.SuggestOpenAPIAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	SuggestOpenAPIRequest	✔️	The request object to use for the request.

Response

SuggestOpenAPIResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*

SuggestOpenAPIRegistry

Get suggestions from an LLM model for improving an OpenAPI document stored in the registry.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

SuggestOpenAPIRegistryRequest req = new SuggestOpenAPIRegistryRequest() {
    NamespaceName = "<value>",
    RevisionReference = "<value>",
    XSessionId = "<id>",
};

var res = await sdk.Suggest.SuggestOpenAPIRegistryAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	SuggestOpenAPIRegistryRequest	✔️	The request object to use for the request.

Response

SuggestOpenAPIRegistryResponse

Errors

Error Type	Status Code	Content Type
SpeakeasySDK.Models.Errors.SDKException	4XX, 5XX	*/*