DataVision.BeeYard.Sdk 12.11.3

C# SDK for BeeYard

Documentation

See https://docs.beeyard.ai/docs/beeyard-sdks/csharp/getting-started/.

Installation

dotnet add package DataVision.BeeYard.Sdk

Example usage

Authentication

• Create HiveClient to interact with Hive. This example uses the client credentials grant, see the docs for other options. HiveClient uses HttpClient internally, so the same rules concerning disposability apply.

  using System.Reflection;
  using DataVision.BeeYard.Sdk;
  using DataVision.BeeYard.Sdk.Tokens;
  
  var uri = new Uri("https://demo.beeyard.ai/hive/");
  
  // optional user agent
  var version = typeof(HiveClient).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>().InformationalVersion;
  var agent = new UserAgent("csharp-sdk", version);
  
  var clientCredentials = new ClientCredentials("{client id}", "{client secret}");
  var tokenUri = new Uri("https://demo.beeyard.ai/id/oauth/token");
  var client = HiveClient.CreateWithClientCredentials(uri, tokenUri, clientCredentials, userAgent: agent);
  

Working with Cells

• Create a Cell in the default Workspace. Read errors if Cell creation fails.

  using DataVision.BeeYard.Sdk.Hive.Cells;
  using DataVision.BeeYard.Sdk.Hive.Cells.Tags;
  using DataVision.BeeYard.Sdk.Hive.Cells.Properties;
  
  var cellId = Guid.NewGuid();
  var @namespace = "workspace0";
  var workspaceTag = Tag.CreateWorkspaceTag(@namespace);
  var property42 = Property.FromLong("Number", 42);
  
  var cellDescriptorInput = new CellDescriptorInput();
  cellDescriptorInput.Id = cellId;
  cellDescriptorInput.Description = "Cell created from C# SDK";
  cellDescriptorInput.Created = DateTime.UtcNow - TimeSpan.FromDays(1);
  cellDescriptorInput.Tags.Add(workspaceTag);
  cellDescriptorInput.Properties.Add(property42);
  
  using var response = await client.CreateCellAsync(cellDescriptorInput);
  if(!response.IsSuccessStatusCode)
  {
      Console.WriteLine("Failed to create cell");
      var errors = await response.ReadErrorsAsync();
      foreach(var error in errors)
      {
          Console.WriteLine(error.Message);
      }
  }
  

• Add Tag to the just created Cell.

  var tagA = Tag.FromTagTemplate(templateA, @namespace);
  using var response = await client.AddTagAsync(cellId, tagA);
  response.EnsureSuccessStatusCode();
  

• Add image to Cell.

  using System.IO;
  
  var imageName = "image.png";
  using var stream = File.OpenRead("{path to image}");
  using var response = await client.AddImageAsync(cellId, imageName, stream);
  response.EnsureSuccessStatusCode();
  

• Read image from Cell.

  using var response = await client.ReadFileAsync(cellId, imageName);
  response.EnsureSuccessStatusCode();
  
  Console.WriteLine($"{response.FileType} - {response.MimeType}: {response.Size} bytes");
  using var content = await response.ReadPayloadAsStreamAsync();
  // process image content
  

• Remove image from Cell.

  using var response = await client.RemoveFileAsync(cellId, imageName);
  response.EnsureSuccessStatusCode();
  

• Remove Cell.

  using var response = await client.RemoveCellAsync(id);
  response.EnsureSuccessStatusCode();